Submit a single text prompt to Anthropic AI, and return only the message generated. Convenience method for single request prompts to the messages
endpoint.
Text prompt to submit
Optional
options: objectAn optional object containing parameters to pass with the body of the request. If not included, a default version with the required model
(claude-3-haiku-20240307) and max_tokens
(1024) values will be used.
Optional
credentialOptional identifier for API Key credentials. If an API Key is not provided as a parameter when instantiating the object, the user will be prompted to enter one of the first time they run an action requiring it. By default, these will be stored as Anthropic AI
credentials.
Create new instance.
Optional
apiKey: stringOptional
lastIf a function fails, this property will contain the last error as a string message, otherwise it will be undefined
.
If a function succeeds, this property will contain the last response returned.
Time in seconds to wait for a request to receive a response from the server. Default: 120 seconds.
Execute a request against the Anthropic AI API. For successful requests, the HTTPResponse object will contain an object or array or objects decoded from the JSON returned by the API as appropriate to the request made in the responseData
property. Refer to Anthropic API documentation for details about the expected parameters and responses.
Optional
data?: { An object containing data to be encoded into the HTTP body of the request. Drafts will take care of the JSON conversion.
Optional
headers?: { An object contain key-values to be added as custom headers in the request. There is no need to provide authorization headers, Drafts will add those.
The HTTP method, like "GET", "POST", etc.
Optional
parameters?: { An object containing key-values to be added to the request as URL parameters. Drafts will take care of encoding these.
The path to the API endpoint in the Anthropic API. Include only the path portion of the URL, the default host will be appended.
Static
createCreates a new AnthropicAI object.
Optional
apiKey: stringA valid Anthropic API Key. This value is optional, and if not provided, the default Anthropic AI API key stored in Credentials will be used, or the user prompted to provide an API Key to store. Only provide a specific API Key if you desire to override the default.
Static
knownReturns a list of current known model versions. Anthropic does not provide an API endpoint to request available models, so this list will be updated periodically with known models for the API. The list currently returns the current Clause Haiku, Sonnet, and Open model versions. If you are using these values to pass a model name to other functions, in general, the first model in this array will be the fastest, the last the most sophisticated. The only purpose of this function over statically defining model names in your actions is that it may be updated overtime if Anthropic releases updated model versions.
Script integration with Anthropic's AI API, including support for conversing with its Claude models. This object offers convenience over direct HTTP requests by:
Example
Translation