AI/ML API
AI/ML API provides a suite of AI models and solutions for various tasks, including text generation, image processing, and more.
Tools (30)
Cancel Run
Tool to cancel a run that is currently in progress. Use when you need to stop an assistant run before it completes.
Inputs: run_id, thread_id
Create Assistant
Tool to create an AI assistant with configurable model, instructions, and tools. Use when you need to set up a new assistant that can maintain conversation context and use tools like code_interpreter or file_search.
Inputs: name, model, tools, top_p, metadata, description, temperature, instructions, tool_resources, response_format, reasoning_effort
Create Message
Tool to create a new message in a thread. Use when you need to add a user or assistant message to an existing conversation thread.
Inputs: role, content, metadata, thread_id, attachments
Create Run
Tool to create a run that executes an assistant on a thread. The assistant processes messages in the thread and generates responses based on its instructions and available tools.
Inputs: model, tools, top_p, metadata, thread_id, temperature, tool_choice, assistant_id, instructions, response_format, max_prompt_tokens, additional_messages, parallel_tool_calls, truncation_strategy, max_completion_tokens
Create Thread
Tool to create a new thread for conversation with an assistant. Threads store messages and maintain context across interactions. Use when starting a new conversation or when you need a fresh context for assistant interactions.
Inputs: messages, metadata, tool_resources
Delete Assistant
Tool to delete an assistant by ID. Use when you need to remove an assistant that is no longer needed.
Inputs: assistant_id
Delete Message
Tool to delete a specific message from a thread. Use when you need to remove an unwanted or erroneous message from a conversation thread.
Inputs: thread_id, message_id
Delete Thread
Tool to delete a thread by its ID. Use when you need to remove an existing thread from the system.
Inputs: thread_id
Get Assistant
Tool to retrieve details of a specific assistant by ID. Use when you need to fetch configuration, model settings, instructions, or available tools for an existing assistant.
Inputs: assistant_id
Get Billing Balance
Tool to retrieve the current billing balance for the account. Use when you need to check available credits, balance status, or auto-debit configuration.
Get Luma Generation
Tool to fetch Luma AI video generation results by generation IDs. Use after creating a generation to check its status and retrieve the generated video URL when completed.
Inputs: ids
Get Message
Tool to retrieve information about a specific message by its ID. Use when you need to fetch details of a particular message in a thread.
Inputs: thread_id, message_id
Get Response by ID
Tool to retrieve a previously generated model response by its unique ID. Use when you need to access details of a specific response, including its output, status, and usage statistics.
Inputs: include, response_id, starting_after, include_obfuscation
Get Run
Tool to retrieve a specific run by ID from a thread. Use when you need to check the status, results, or details of a previously created run.
Inputs: run_id, thread_id
Get Run Step
Tool to retrieve a specific run step by its ID within a thread and run. Use when you need detailed information about a particular step's execution status and results.
Inputs: run_id, step_id, thread_id
Get Thread
Tool to retrieve information about a specific thread by ID. Use when you need to fetch thread details, metadata, or available tool resources for an existing conversation thread.
Inputs: thread_id
List Assistants
Tool to list all assistants associated with the account. Use when you need to retrieve available assistants with pagination support.
Inputs: after, limit, order, before
List Batches
Tool to get the status or results of a batch processing job. Use when you need to check the progress or retrieve results of a previously submitted batch.
Inputs: batch_id
List Luma AI Generations
Tool to fetch user's Luma AI video generations. Use when you need to retrieve a list of all Luma AI video generation tasks for the authenticated user.
Inputs: limit, offset
List Thread Messages
Tool to retrieve a list of messages from a specific thread. Use when you need to fetch conversation history or message content from an AI assistant thread.
Inputs: after, limit, order, before, run_id, thread_id
List Models
Tool to list all available AI models from the AI/ML API. Use when you need to retrieve the complete catalog of 400+ models including chat, image, video, voice, and other model types.
List Models With Details
Tool to list all available AI/ML models with detailed information including pricing, features, and capabilities. Use when you need to discover available models or get comprehensive model metadata.
List Runs
Tool to list all runs for a specific thread. Use when you need to retrieve runs with pagination support.
Inputs: after, limit, order, before, thread_id
List Run Steps
Tool to list the steps in a run. Use when you need to retrieve and examine the execution steps of a specific run within a thread.
Inputs: after, limit, order, before, run_id, thread_id
Submit Tool Outputs
Tool to submit tool outputs for a run that requires action. Use when a run has status 'requires_action' and needs tool call results to continue execution.
Inputs: run_id, stream, thread_id, tool_outputs
Text Chat Completion
Tool to generate text completions or chat responses using a specified LLM model. Use after assembling the conversation history to produce the next response.
Inputs: n, stop, user, model, top_p, stream, messages, logit_bias, max_tokens, temperature, presence_penalty, frequency_penalty
Update Assistant
Tool to modify an existing assistant's properties including name, instructions, model, and tools. Use when you need to update an assistant's configuration or behavior after it has been created.
Inputs: name, model, tools, top_p, metadata, description, temperature, assistant_id, instructions, tool_resources, response_format, reasoning_effort
Update Message
Tool to modify metadata for a specific message in a thread. Use when you need to update message metadata such as tags or custom fields.
Inputs: metadata, thread_id, message_id
Update Run
Tool to update a run's metadata with key-value pairs. Use when you need to attach or modify additional information for a specific run.
Inputs: run_id, metadata, thread_id
Update Thread
Tool to update thread metadata and tool resources in the AI/ML API. Use when you need to modify existing thread properties or attach resources.
Inputs: metadata, thread_id, tool_resources