--- title: Run a Workers AI model --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [AI](https://developers.cloudflare.com/api/typescript/resources/ai) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Run a Workers AI model client.ai.run(stringmodelName, AIRunParamsparams, RequestOptionsoptions?): [AIRunResponse]() POST/accounts/{account\_id}/ai/run/{model\_name} Runs the Workers AI model specified in the URL path. Send the model’s inputs directly in the request body, without a model/input/options wrapper. Accepts model-specific JSON or binary input. The response format depends on the model and the requested output. See the [model catalog](https://developers.cloudflare.com/workers-ai/models/) for supported models and their input formats. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Workers AI Write``Workers AI Read` ##### ParametersExpand Collapse modelName: string Workers AI model identifier, including its namespace and model name. [Link to this property](<#(resource)%20ai%20%3E%20(method)%20run%20%3E%20(params)%200%20%3E%20(param)%20model_name%20%3E%20(schema)>)
AIRunParams = TextClassification| TextToImage| TextToSpeech| 12 more
AIRunParamsBase {account\_id, text } account\_id: string Path param: Cloudflare account ID used for this AI model request. Link to this property text: string Body param: The text that you want to classify minLength1 Link to this property
Link to this property TextClassification extends AIRunParamsBase {account\_id, text } Link to this property TextToImage extends AIRunParamsBase {account\_id, text } Link to this property TextToSpeech extends AIRunParamsBase {account\_id, text } Link to this property TextEmbeddings extends AIRunParamsBase {account\_id, text } Link to this property AutomaticSpeechRecognition extends AIRunParamsBase {account\_id, text } Link to this property ImageClassification extends AIRunParamsBase {account\_id, text } Link to this property ObjectDetection extends AIRunParamsBase {account\_id, text } Link to this property Prompt extends AIRunParamsBase {account\_id, text } Link to this property Messages extends AIRunParamsBase {account\_id, text } Link to this property Translation extends AIRunParamsBase {account\_id, text } Link to this property Summarization extends AIRunParamsBase {account\_id, text } Link to this property ImageToText extends AIRunParamsBase {account\_id, text } Link to this property Variant12 extends AIRunParamsBase {account\_id, text } Link to this property Variant13 extends AIRunParamsBase {account\_id, text } Link to this property MultimodalEmbeddings extends AIRunParamsBase {account\_id, text } Link to this property
[Link to this property](<#(resource)%20ai%20%3E%20(method)%20run.typescript.params>) ##### ReturnsExpand Collapse
AIRunResponse = Array<TextClassification>| Uploadable| Audio {audio } | 12 more An array of classification results for the input text One of the following:
Array<TextClassification> label?: string The classification label assigned to the text (e.g., ‘POSITIVE’ or ‘NEGATIVE’) Link to this property score?: number Confidence score indicating the likelihood that the text belongs to the specified label Link to this property
Link to this property Uploadable Link to this property
Audio {audio } audio?: string The generated audio in MP3 format, base64-encoded Link to this property
Link to this property Uploadable Link to this property
TextEmbeddings {data, shape } data?: Array<Array<number>> Embeddings of the requested text values Link to this property shape?: Array<number> Link to this property
Link to this property
AutomaticSpeechRecognition {text, vtt, word\_count, words } text: string The transcription Link to this property vtt?: string Link to this property word\_count?: number Link to this property
words?: Array<Word> end?: number The ending second when the word completes Link to this property start?: number The second this word begins in the recording Link to this property word?: string Link to this property
Link to this property
Link to this property
Array<ImageClassification> label?: string The predicted category or class for the input image based on analysis Link to this property score?: number A confidence value, between 0 and 1, indicating how certain the model is about the predicted label Link to this property
Link to this property
Array<ObjectDetection>
box?: Box {xmax, xmin, ymax, ymin } Coordinates defining the bounding box around the detected object xmax?: number The x-coordinate of the bottom-right corner of the bounding box Link to this property xmin?: number The x-coordinate of the top-left corner of the bounding box Link to this property ymax?: number The y-coordinate of the bottom-right corner of the bounding box Link to this property ymin?: number The y-coordinate of the top-left corner of the bounding box Link to this property
Link to this property label?: string The class label or name of the detected object Link to this property score?: number Confidence score indicating the likelihood that the detection is correct Link to this property
Link to this property
UnionMember8 {response, tool\_calls, usage } response: string The generated text response from the model Link to this property
tool\_calls?: Array<ToolCall> An array of tool calls requests made during the response generation arguments?: unknown The arguments passed to be passed to the tool call request Link to this property name?: string The name of the tool to be called Link to this property
Link to this property
usage?: Usage {completion\_tokens, prompt\_tokens, total\_tokens } Usage statistics for the inference request completion\_tokens?: number Total number of tokens in output Link to this property prompt\_tokens?: number Total number of tokens in input Link to this property total\_tokens?: number Total number of input and output tokens Link to this property
Link to this property
Link to this property Uploadable Link to this property
Translation {translated\_text } translated\_text?: string The translated text in the target language Link to this property
Link to this property
Summarization {summary } summary?: string The summarized version of the input text Link to this property
Link to this property
ImageToText {description } description?: string Link to this property
Link to this property
ImageTextToText {description } description?: string Link to this property
Link to this property
MultimodalEmbeddings {data, shape } data?: Array<Array<number>> Link to this property shape?: Array<number> Link to this property
Link to this property
[Link to this property](<#(resource)%20ai%20%3E%20(model)%20ai_run_response%20%3E%20(schema)>) ### Run a Workers AI model TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.ai.run('@cf/meta/llama-3.1-8b-instruct', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', text: 'x', }); console.log(response); ``` 200 example ``` { "result": [ { "label": "label", "score": 0 } ] } ``` ##### Returns Examples 200 example ``` { "result": [ { "label": "label", "score": 0 } ] } ```