Drafts Script Reference
    Preparing search index...

    Class AnthropicAI

    Script integration with Anthropic's AI API, including support for conversing with its Claude models. This object offers convenience over direct HTTP requests by:

    • Integrating with Drafts Credentials system to store your API key.
    • Handling request authorization headers for requests
    • Parsing results to JSON
    • Providing several convenience functions that wrap more complex API calls into simple requests.

    NOTE: Drafts does not provide an API Key for use with Anthropic. To use Anthropic AI features, you will have to setup your own API Key for use with Drafts in the Anthropic Console.

    Translation

    // build prompt
    const targetLanguage = "Spanish"
    const text = "Where is the library?"
    const chatPrompt = `Translate the following text into ${targetLanguage}: "${text}"`

    // create API object and use single response
    // convenience function to send prompt
    let ai = new AnthropicAI()
    let answer = ai.quickPrompt(chatPrompt)

    // answer == "¿Dónde está la biblioteca?"
    Index

    Convenience

    quickPrompt

    Options

    credentialIdentifier?

    Other

    constructor lastError? lastResponse timeout request create knownModels

    Convenience

    • Submit a single text prompt to Anthropic AI, and return only the message generated. Convenience method for single request prompts to the messages endpoint.

      Parameters

      • prompt: string

        Text prompt to submit

      • Optionaloptions: object

        An 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.

      Returns string

    Options

    credentialIdentifier?: string

    Optional 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.

    Other

    • Create new instance.

      Parameters

      • OptionalapiKey: string

      Returns AnthropicAI

    lastError?: string

    If a function fails, this property will contain the last error as a string message, otherwise it will be undefined.

    lastResponse: any

    If a function succeeds, this property will contain the last response returned.

    timeout: number

    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.

      Parameters

      • settings: {
            data?: { [x: string]: string };
            headers?: { [x: string]: string };
            method: string;
            parameters?: { [x: string]: string };
            path: string;
        }
        • Optionaldata?: { [x: string]: string }

          An object containing data to be encoded into the HTTP body of the request. Drafts will take care of the JSON conversion.

        • Optionalheaders?: { [x: string]: string }

          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.

        • method: string

          The HTTP method, like "GET", "POST", etc.

        • Optionalparameters?: { [x: string]: string }

          An object containing key-values to be added to the request as URL parameters. Drafts will take care of encoding these.

        • path: string

          The path to the API endpoint in the Anthropic API. Include only the path portion of the URL, the default host will be appended.

      Returns HTTPResponse

    • Creates a new AnthropicAI object.

      Parameters

      • OptionalapiKey: string

        A 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.

      Returns AnthropicAI

    • Returns a list of current known model versions for the API key in use.

      Returns [string]

    Settings

    Member Visibility

    On This Page

    Convenience
    Options
    Other