Skip to content
Changelog

Report a bug

Mistral AI integration: operations for AI agents

Mistral AI connects to Type.com as an integration. This page lists the 321 operations documented for Claude and Codex in Type.com: 159 read, 104 write, 58 destructive.

About Mistral AI

Mistral AI API reference operations, subject to Type setup and account permissions.

Categories: Developer Tools & IT

How to connect Mistral AI to Type.com

Connect
Configure provider-specific API target and authentication setup.
Access
Organization connection: one shared account for the workspace.
MCP
Selected AI voice-generation operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.

To add the connection, follow the steps in Space connections.

Documented operations

321 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

321 operations listed.

beta.prompts

  • Read

    ListPrompts

    ListPrompts

    GET /v2/prompts

  • Read

    GetPrompt

    GetPrompt

    GET /v2/prompts/{prompt_id}

  • Read

    ListPromptVersions

    ListPromptVersions

    GET /v2/prompts/{prompt_id}/versions

  • Read

    GetPromptVersion

    GetPromptVersion

    GET /v2/prompts/{prompt_id}/versions/{version}

  • Write

    CreatePrompt

    CreatePrompt

    POST /v2/prompts

  • Write

    UpdatePrompt

    UpdatePrompt

    PATCH /v2/prompts/{prompt_id}

  • Write

    CreatePromptVersion

    CreatePromptVersion

    POST /v2/prompts/{prompt_id}/versions

  • Write

    UpdatePromptVersionMetadata

    UpdatePromptVersionMetadata

    PATCH /v2/prompts/{prompt_id}/versions/{version}

  • Destructive

    DeletePrompt

    DeletePrompt

    DELETE /v2/prompts/{prompt_id}

beta.skills

  • Read

    ListSkills

    ListSkills

    GET /v2/skills

  • Read

    GetSkill

    GetSkill

    GET /v2/skills/{skill_id}

  • Read

    ListSkillVersions

    ListSkillVersions

    GET /v2/skills/{skill_id}/versions

  • Read

    GetSkillVersion

    GetSkillVersion

    GET /v2/skills/{skill_id}/versions/{version}

  • Write

    CreateSkill

    CreateSkill

    POST /v2/skills

  • Write

    UpdateSkill

    UpdateSkill

    PATCH /v2/skills/{skill_id}

  • Write

    CreateSkillVersion

    CreateSkillVersion

    POST /v2/skills/{skill_id}/versions

  • Write

    UpdateSkillVersionMetadata

    UpdateSkillVersionMetadata

    PATCH /v2/skills/{skill_id}/versions/{version}

  • Destructive

    DeleteSkill

    DeleteSkill

    DELETE /v2/skills/{skill_id}

audio.speech

  • Write

    Speech

    Speech

    POST /v1/audio/speech

models

  • Read

    List Models

    List all models available to the user.

    GET /v1/models

  • Read

    Retrieve Model

    Retrieve information about a model.

    GET /v1/models/{model_id}

  • Write

    Update Fine Tuned Model

    Update a model name or description.

    PATCH /v1/fine_tuning/models/{model_id}

  • Write

    Archive Fine Tuned Model

    Archive a fine-tuned model.

    POST /v1/fine_tuning/models/{model_id}/archive

  • Destructive

    Delete Model

    Delete a fine-tuned model.

    DELETE /v1/models/{model_id}

  • Destructive

    Unarchive Fine Tuned Model

    Un-archive a fine-tuned model.

    DELETE /v1/fine_tuning/models/{model_id}/archive

realtime.sessions

  • Write

    Create Client Session

    Create a client session. Requires the `create_client_session` permission.

    POST /v1/client/sessions

beta.service_accounts

  • Read

    List Service Accounts

    List the service accounts in a workspace, or across the organization. Scoped to a workspace, this requires the Workspace admin (`workspace_admin`) role on it. Omitting the workspace lists the whole organization and requires the Organization admin (`organization_admin`) role instead. ``q`` narrows the list to accounts whose name or description contains it. ``order`` sorts by creation time (ascending by default).

    GET /v1/service-accounts

  • Read

    List Assignable Service Account Roles

    List the workspace roles that can be assigned to a service account. Requires the Workspace admin (`workspace_admin`) role.

    GET /v1/service-accounts/assignable-roles

  • Read

    Get Service Account

    Retrieve a service account. Requires the Workspace admin (`workspace_admin`) role.

    GET /v1/service-accounts/{service_account_id}

  • Read

    List Service Account Roles

    List the workspace roles assigned to a service account. Requires the Workspace admin (`workspace_admin`) role.

    GET /v1/service-accounts/{service_account_id}/roles

  • Write

    Create Service Account

    Create a service account in a workspace. Requires the Workspace admin (`workspace_admin`) role.

    POST /v1/service-accounts

  • Write

    Update Service Account

    Update a service account. Requires the Workspace admin (`workspace_admin`) role.

    PATCH /v1/service-accounts/{service_account_id}

  • Destructive

    Delete Service Account

    Delete a service account. Requires the Workspace admin (`workspace_admin`) role.

    DELETE /v1/service-accounts/{service_account_id}

  • Destructive

    Set Service Account Roles

    Replace the workspace roles assigned to a service account. Requires the Workspace admin (`workspace_admin`) role.

    PUT /v1/service-accounts/{service_account_id}/roles

beta.conversations

  • Read

    List all created conversations.

    Retrieve a list of conversation entities sorted by creation time.

    GET /v1/conversations

  • Read

    Retrieve a conversation information.

    Given a conversation_id retrieve a conversation entity with its attributes.

    GET /v1/conversations/{conversation_id}

  • Read

    Retrieve all entries in a conversation.

    Given a conversation_id retrieve all the entries belonging to that conversation. The entries are sorted in the order they were appended, those can be messages, connectors or function_call.

    GET /v1/conversations/{conversation_id}/history

  • Read

    Retrieve all messages in a conversation.

    Given a conversation_id retrieve all the messages belonging to that conversation. This is similar to retrieving all entries except we filter the messages only.

    GET /v1/conversations/{conversation_id}/messages

  • Write

    Create a conversation and append entries to it.

    Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation.

    POST /v1/conversations

  • Write

    Append new entries to an existing conversation.

    Run completion on the history of the conversation and the user entries. Return the new created entries.

    POST /v1/conversations/{conversation_id}

  • Write

    Restart a conversation starting from a given entry.

    Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned.

    POST /v1/conversations/{conversation_id}/restart

  • Write

    Create a conversation and append entries to it.

    Create a new conversation, using a base model or an agent and append entries. Completion and tool executions are run and the response is appended to the conversation.Use the returned conversation_id to continue the conversation.

    POST /v1/conversations#stream

  • Write

    Append new entries to an existing conversation.

    Run completion on the history of the conversation and the user entries. Return the new created entries.

    POST /v1/conversations/{conversation_id}#stream

  • Write

    Restart a conversation starting from a given entry.

    Given a conversation_id and an id, recreate a conversation from this point and run completion. A new conversation is returned with the new entries returned.

    POST /v1/conversations/{conversation_id}/restart#stream

  • Destructive

    Delete a conversation.

    Delete a conversation given a conversation_id.

    DELETE /v1/conversations/{conversation_id}

beta.agents

  • Read

    List agent entities. (deprecated)

    Retrieve a list of agent entities sorted by creation time. Deprecated: some features such as agent sharing are not supported by this endpoint. Use the cursor-paginated `GET /v1/agents/pages` instead.

    GET /v1/agents

  • Read

    List agent entities, cursor-paginated.

    Retrieve a page of agent entities. Unlike the deprecated `GET /v1/agents`, this endpoint paginates by opaque cursor and honors per-agent sharing, returning only agents the caller is authorized to see.

    GET /v1/agents/pages

  • Read

    Retrieve an agent entity.

    Given an agent, retrieve an agent entity with its attributes. The agent_version parameter can be an integer version number or a string alias.

    GET /v1/agents/{agent_id}

  • Read

    List all versions of an agent.

    Retrieve all versions for a specific agent with full agent context. Supports pagination.

    GET /v1/agents/{agent_id}/versions

  • Read

    Retrieve a specific version of an agent.

    Get a specific agent version by version number.

    GET /v1/agents/{agent_id}/versions/{version}

  • Read

    List all aliases for an agent.

    Retrieve all version aliases for a specific agent.

    GET /v1/agents/{agent_id}/aliases

  • Write

    Create a agent that can be used within a conversation.

    Create a new agent giving it instructions, tools, description. The agent is then available to be used as a regular assistant in a conversation or as part of an agent pool from which it can be used.

    POST /v1/agents

  • Write

    Update an agent entity.

    Update an agent attributes and create a new version.

    PATCH /v1/agents/{agent_id}

  • Write

    Update an agent version.

    Switch the version of an agent.

    PATCH /v1/agents/{agent_id}/version

  • Write

    Create or update an agent version alias.

    Create a new alias or update an existing alias to point to a specific version. Aliases are unique per agent and can be reassigned to different versions.

    PUT /v1/agents/{agent_id}/aliases

  • Destructive

    Delete an agent entity.

    Delete an agent entity.

    DELETE /v1/agents/{agent_id}

  • Destructive

    Delete an agent version alias.

    Delete an existing alias for an agent.

    DELETE /v1/agents/{agent_id}/aliases

files

  • Read

    List Files

    Returns a list of files that belong to the user's organization.

    GET /v1/files

  • Read

    Retrieve File

    Returns information about a specific file.

    GET /v1/files/{file_id}

  • Read

    Download File

    Download a file

    GET /v1/files/{file_id}/content

  • Read

    Get Signed Url

    Get Signed Url

    GET /v1/files/{file_id}/url

  • Write

    Upload File

    Upload a file that can be used across various endpoints. The size of individual files can be a maximum of 512 MB. The Fine-tuning API only supports .jsonl files. Please contact us if you need to increase these storage limits.

    POST /v1/files

  • Destructive

    Delete File

    Delete a file.

    DELETE /v1/files/{file_id}

batch

  • Read

    Get Batch Jobs

    Get a list of batch jobs for your organization and user.

    GET /v1/batch/jobs

  • Read

    Get Batch Job

    Get a batch job details by its UUID. Args: inline: If True, return results inline in the response.

    GET /v1/batch/jobs/{job_id}

  • Write

    Create Batch Job

    Create a new batch job, it will be queued for processing.

    POST /v1/batch/jobs

  • Destructive

    Delete Batch Job

    Request the deletion of a batch job.

    DELETE /v1/batch/jobs/{job_id}

  • Destructive

    Cancel Batch Job

    Request the cancellation of a batch job.

    POST /v1/batch/jobs/{job_id}/cancel

chat

  • Write

    Chat Completion

    Chat Completion

    POST /v1/chat/completions

fim

  • Write

    Fim Completion

    FIM completion.

    POST /v1/fim/completions

agents

  • Write

    Agents Completion

    Agents Completion

    POST /v1/agents/completions

embeddings

  • Write

    Embeddings

    Embeddings

    POST /v1/embeddings

classifiers

  • Write

    Moderations

    Moderations

    POST /v1/moderations

  • Write

    Chat Moderations

    Chat Moderations

    POST /v1/chat/moderations

  • Write

    Classifications

    Classifications

    POST /v1/classifications

  • Write

    Chat Classifications

    Chat Classifications

    POST /v1/chat/classifications

ocr

  • Write

    OCR

    OCR

    POST /v1/ocr

audio.transcriptions

  • Write

    Create Transcription

    Create Transcription

    POST /v1/audio/transcriptions

  • Write

    Create Streaming Transcription (SSE)

    Create Streaming Transcription (SSE)

    POST /v1/audio/transcriptions#stream

beta.libraries

  • Read

    List all libraries you have access to.

    List all libraries that you have created or have been shared with you.

    GET /v1/libraries

  • Read

    Detailed information about a specific Library.

    Given a library id, details information about that Library.

    GET /v1/libraries/{library_id}

  • Write

    Create a new Library.

    Create a new Library, you will be marked as the owner and only you will have the possibility to share it with others. When first created this will only be accessible by you.

    POST /v1/libraries

  • Write

    Update a library.

    Given a library id, you can update the name and description.

    PATCH /v1/libraries/{library_id}

  • Write

    Update a library. (deprecated)

    Given a library id, you can update the name and description.

    PUT /v1/libraries/{library_id}

  • Destructive

    Delete a library and all of it's document.

    Given a library id, deletes it together with all documents that have been uploaded to that library. Warning: the response will change from 200 (returning the deleted library) to 204 No Content in a future version.

    DELETE /v1/libraries/{library_id}

beta.libraries.documents

  • Read

    List documents in a given library.

    Given a library, lists the document that have been uploaded to that library.

    GET /v1/libraries/{library_id}/documents

  • Read

    Retrieve the metadata of a specific document.

    Given a library and a document in this library, you can retrieve the metadata of that document.

    GET /v1/libraries/{library_id}/documents/{document_id}

  • Read

    Retrieve the text content of a specific document.

    Given a library and a document in that library, you can retrieve the text content of that document if it exists. For documents like pdf, docx and pptx the text content results from our processing using Mistral OCR.

    GET /v1/libraries/{library_id}/documents/{document_id}/text_content

  • Read

    Retrieve the processing status of a specific document.

    Given a library and a document in that library, retrieve the processing status of that document.

    GET /v1/libraries/{library_id}/documents/{document_id}/status

  • Read

    Retrieve the signed URL of a specific document.

    Given a library and a document in that library, retrieve the signed URL of a specific document.The url will expire after 30 minutes and can be accessed by anyone with the link.

    GET /v1/libraries/{library_id}/documents/{document_id}/signed-url

  • Read

    Retrieve the signed URL of text extracted from a given document.

    Given a library and a document in that library, retrieve the signed URL of text extracted. For documents that are sent to the OCR this returns the result of the OCR queries.

    GET /v1/libraries/{library_id}/documents/{document_id}/extracted-text-signed-url

  • Write

    Upload a new document.

    Given a library, upload a new document to that library. It is queued for processing, it status will change it has been processed. The processing has to be completed in order be discoverable for the library search

    POST /v1/libraries/{library_id}/documents

  • Write

    Reprocess a document.

    Given a library and a document in that library, reprocess that document, it will be billed again.

    POST /v1/libraries/{library_id}/documents/{document_id}/reprocess

  • Destructive

    Update the metadata of a specific document.

    Given a library and a document in that library, update the name and/or attributes of that document.

    PATCH /v1/libraries/{library_id}/documents/{document_id}

  • Destructive

    Update the metadata of a specific document. (deprecated)

    Given a library and a document in that library, update the name of that document.

    PUT /v1/libraries/{library_id}/documents/{document_id}

  • Destructive

    Delete a document.

    Given a library and a document in that library, delete that document. The document will be deleted from the library and the search index.

    DELETE /v1/libraries/{library_id}/documents/{document_id}

beta.libraries.accesses

  • Read

    List all of the access to this library.

    Given a library, list all of the Entity that have access and to what level.

    GET /v1/libraries/{library_id}/share

  • Write

    Create or update an access level.

    Given a library id, you can create or update the access level of an entity. You have to be owner of the library to share a library. An owner cannot change their own role. A library cannot be shared outside of the organization.

    PUT /v1/libraries/{library_id}/share

  • Destructive

    Delete an access level.

    Given a library id, you can delete the access level of an entity. An owner cannot delete their own access. You have to be the owner of the library to delete an access other than yours. Warning: the response will change from 200 (returning the deleted sharing) to 204 No Content in a future version.

    DELETE /v1/libraries/{library_id}/share

beta.observability.judges

  • Read

    Get judges with optional filtering and search

    Get judges with optional filtering and search

    GET /v1/observability/judges

  • Read

    Get judge by id

    Get judge by id

    GET /v1/observability/judges/{judge_id}

  • Write

    Create a new judge

    Create a new judge

    POST /v1/observability/judges

  • Write

    Update a judge

    Update a judge

    PUT /v1/observability/judges/{judge_id}

  • Write

    Run a saved judge on a conversation

    Run a saved judge on a conversation

    POST /v1/observability/judges/{judge_id}/live-judging

  • Destructive

    Delete a judge

    Delete a judge

    DELETE /v1/observability/judges/{judge_id}

beta.observability.datasets

  • Read

    List existing datasets

    List existing datasets

    GET /v1/observability/datasets

  • Read

    Get dataset by ID or slug

    Get dataset by ID or slug

    GET /v1/observability/datasets/{dataset_id}

  • Read

    List existing records in the dataset

    List existing records in the dataset

    GET /v1/observability/datasets/{dataset_id}/records

  • Read

    Export to the Files API and retrieve presigned URL to download the resulting JSONL file

    Export to the Files API and retrieve presigned URL to download the resulting JSONL file

    GET /v1/observability/datasets/{dataset_id}/exports/to-jsonl

  • Read

    Get status of a dataset import task

    Get status of a dataset import task

    GET /v1/observability/datasets/{dataset_id}/tasks/{task_id}

  • Read

    List import tasks for the given dataset

    List import tasks for the given dataset

    GET /v1/observability/datasets/{dataset_id}/tasks

  • Write

    Create a new empty dataset

    Create a new empty dataset

    POST /v1/observability/datasets

  • Write

    Patch dataset

    Patch dataset

    PATCH /v1/observability/datasets/{dataset_id}

  • Write

    Add a record to the dataset

    Add a record to the dataset

    POST /v1/observability/datasets/{dataset_id}/records

  • Write

    Populate the dataset with records from an uploaded file

    Populate the dataset with records from an uploaded file

    POST /v1/observability/datasets/{dataset_id}/imports/from-file

  • Write

    Populate the dataset with records from playground conversations

    Populate the dataset with records from playground conversations

    POST /v1/observability/datasets/{dataset_id}/imports/from-playground

  • Write

    Populate the dataset with records mapped from telemetry spans

    Starts an asynchronous import of the requested telemetry spans. References not returned by the tenant-scoped telemetry query are skipped without distinguishing absence from access restrictions.

    POST /v1/observability/datasets/{dataset_id}/imports/from-spans

  • Write

    Populate the dataset with records from another dataset

    Populate the dataset with records from another dataset

    POST /v1/observability/datasets/{dataset_id}/imports/from-dataset

  • Destructive

    Delete a dataset

    Delete a dataset

    DELETE /v1/observability/datasets/{dataset_id}

beta.observability.datasets.records

  • Read

    Get the content of a given dataset record

    Get the content of a given dataset record

    GET /v1/observability/dataset-records/{dataset_record_id}

  • Write

    Run Judge on a dataset record based on the given options

    Run Judge on a dataset record based on the given options

    POST /v1/observability/dataset-records/{dataset_record_id}/live-judging

  • Write

    Update a dataset record payload

    Update a dataset record payload

    PUT /v1/observability/dataset-records/{dataset_record_id}/payload

  • Write

    Update dataset record properties

    Update dataset record properties

    PUT /v1/observability/dataset-records/{dataset_record_id}/properties

  • Destructive

    Delete a record from a dataset

    Delete a record from a dataset

    DELETE /v1/observability/dataset-records/{dataset_record_id}

  • Destructive

    Delete multiple records from datasets

    Delete multiple records from datasets

    POST /v1/observability/dataset-records/bulk-delete

beta.observability.evaluations

  • Read

    List pipelines

    List pipelines

    GET /v1/observability/pipelines

  • Read

    Get a pipeline

    Get a pipeline

    GET /v1/observability/pipelines/{pipeline_id}

  • Read

    List evaluations for a project

    List evaluations for a project

    GET /v1/observability/projects/{project_slug}/evaluations_v2

  • Read

    Get evaluation by slug

    Get evaluation by slug

    GET /v1/observability/evaluations_v2/{evaluation_slug}

  • Write

    Create a pipeline

    Create a pipeline

    POST /v1/observability/pipelines

  • Write

    Update a pipeline

    Update a pipeline

    PUT /v1/observability/pipelines/{pipeline_id}

  • Destructive

    Delete a pipeline

    Delete a pipeline

    DELETE /v1/observability/pipelines/{pipeline_id}

beta.observability.logs

  • Read

    Search logs

    Search logs

    POST /v1/observability/logs/search

  • Read

    Get log field definitions

    Get log field definitions

    GET /v1/observability/logs/fields

  • Read

    Get options for a log field

    Get options for a log field

    GET /v1/observability/logs/fields/{field_name}/options

beta.observability.traces

  • Read

    Search traces

    Search traces

    POST /v1/observability/traces/search

  • Read

    Aggregate traces

    Aggregate traces

    POST /v1/observability/traces/aggregate

  • Read

    Get trace field definitions

    Get trace field definitions

    GET /v1/observability/traces/fields

  • Read

    Get trace by id

    Get trace by id

    GET /v1/observability/traces/{trace_id}

  • Read

    Get trace spans

    Get trace spans

    GET /v1/observability/traces/{trace_id}/spans

  • Read

    Get options for a trace field

    Get options for a trace field

    GET /v1/observability/traces/fields/{field_name}/options

  • Read

    Get span by id

    Get span by id

    GET /v1/observability/traces/{trace_id}/spans/{span_id}

beta.observability.spans

  • Read

    Search spans

    Search spans

    POST /v1/observability/spans/search

  • Read

    Aggregate spans

    Aggregate spans

    POST /v1/observability/spans/aggregate

  • Read

    Aggregate span evaluations

    Aggregate span evaluations

    POST /v1/observability/spans/evaluations/aggregate

  • Read

    Search span evaluations

    Search span evaluations

    POST /v1/observability/spans/evaluations/search

  • Read

    Search latest span evaluations

    Search latest span evaluations

    POST /v1/observability/spans/evaluations/search/latest

  • Read

    Search pipeline results

    Search pipeline results

    POST /v1/observability/pipeline-results/search

  • Read

    Get span field definitions

    Get span field definitions

    GET /v1/observability/spans/fields

  • Read

    Get span evaluation field definitions

    Get span evaluation field definitions

    GET /v1/observability/spans/evaluations/fields

  • Read

    Get options for a span field

    Get options for a span field

    GET /v1/observability/spans/fields/{field_name}/options

  • Read

    Get options for a span evaluation field

    Get options for a span evaluation field

    GET /v1/observability/spans/evaluations/fields/{field_name}/options

beta.observability.evaluations.projects

  • Read

    List projects

    List projects

    GET /v1/observability/projects

  • Read

    Get project by slug

    Get project by slug

    GET /v1/observability/projects/{project_slug}

beta.observability.evaluations.runs

  • Read

    Search evaluation runs with filters

    Search evaluation runs with filters

    POST /v1/observability/evaluations_v2/{evaluation_slug}/runs/search

  • Read

    Search evaluation runs across all evaluations

    Search evaluation runs across all evaluations

    POST /v1/observability/evaluation-runs_v2/search

  • Read

    Get a specific evaluation run by ID

    Get a specific evaluation run by ID

    GET /v1/observability/evaluation-runs_v2/{run_id}

  • Read

    Get statistics for a specific evaluation run

    Get statistics for a specific evaluation run

    GET /v1/observability/evaluation-runs_v2/{run_id}/statistics

  • Read

    Compute statistics for a specific evaluation run with optional filters

    Compute statistics for a specific evaluation run with optional filters

    POST /v1/observability/evaluation-runs_v2/{run_id}/statistics/compute

beta.observability.evaluations.records

  • Read

    Get a specific record from an evaluation run

    Get a specific record from an evaluation run

    GET /v1/observability/evaluation-runs_v2/{run_id}/records/{record_id}

  • Read

    Search records for an evaluation run with content filters

    Search records for an evaluation run with content filters

    POST /v1/observability/evaluation-runs_v2/{run_id}/records/search

beta.observability.evaluations.optimizations

  • Read

    List optimizations with optional filters

    List optimizations with optional filters

    GET /v1/observability/optimizations

  • Read

    Get an optimization by id (with its anchored evaluation + project)

    Get an optimization by id (with its anchored evaluation + project)

    GET /v1/observability/optimizations/{optimization_id}

  • Read

    List an optimization's trials with their observation runs (paginated)

    List an optimization's trials with their observation runs (paginated)

    GET /v1/observability/optimizations/{optimization_id}/trials

beta.connectors

  • Read

    List all connectors.

    List all your custom connectors with keyset pagination and filters.

    GET /v1/connectors

  • Read

    Get the auth URL for a connector.

    Get the OAuth2 authorization URL for a connector to initiate user authentication.

    GET /v1/connectors/{connector_id_or_name}/auth_url

  • Read

    List tools for a connector.

    List all tools available for an MCP connector.

    GET /v1/connectors/{connector_id_or_name}/tools

  • Read

    Get authentication methods for a connector.

    Get the authentication schema for a connector. Returns the list of supported authentication methods and their required headers.

    GET /v1/connectors/{connector_id_or_name}/authentication_methods

  • Read

    List organization credentials for a connector.

    List all credentials configured at the organization level for a given connector.

    GET /v1/connectors/{connector_id_or_name}/organization/credentials

  • Read

    List workspace credentials for a connector.

    List all credentials configured at the workspace level for a given connector.

    GET /v1/connectors/{connector_id_or_name}/workspace/credentials

  • Read

    List user credentials for a connector.

    List all credentials configured at the user level for a given connector.

    GET /v1/connectors/{connector_id_or_name}/user/credentials

  • Read

    Get a connector.

    Get a connector by its ID or name.

    GET /v1/connectors/{connector_id_or_name}#idOrName

  • Write

    Create a new connector.

    Create a new MCP or HTTP connector. You can customize its visibility, URL, and auth type.

    POST /v1/connectors

  • Write

    Share a private connector to the current workspace.

    Transfers ownership of a private user-owned connector to the current workspace, making it available to all workspace members. The creator can later revert this via the unshare endpoint. Any authentication flows that rely on the original owner's identity (e.g. OAuth on-behalf-of) will be affected and must be reconfigured after sharing. Only the connector's creator can call this endpoint. Requires the ShareConnectorToWorkspace workspace permission.

    PUT /v1/connectors/{connector_id}/share

  • Write

    Share a connector to the current organization.

    Transfers ownership of a private user-owned connector to the current organization, making it available to all organization members. The creator can later revert this via the unshare endpoint. Any authentication flows that rely on the original owner's identity (e.g. OAuth on-behalf-of) will be affected and must be reconfigured after sharing. Requires the ShareConnectorToOrg organization permission.

    PUT /v1/connectors/{connector_id}/organization/share

  • Write

    Activate a connector for the given consumer (organization, workspace, user).

    Enable a connector for the consumer.

    POST /v1/connectors/{connector_id}/{consumer_scope}/activate

  • Write

    Create consumer credentials for a connector.

    Create consumer credentials for a given connector and consumer scope (organization, workspace, user)

    POST /v1/connectors/{connector_id_or_name}/{consumer_scope}/credentials

  • Write

    Create or update consumer credentials for a connector.

    Create or update consumer credentials for a given connector.

    PATCH /v1/connectors/{connector_id_or_name}/{consumer_scope}/credentials

  • Write

    Update a connector.

    Update a connector by its ID.

    PATCH /v1/connectors/{connector_id}#id

  • Destructive

    Unshare a connector from the current workspace.

    Reverts a workspace-shared connector back to a private, creator-owned connector. Workspace-scoped connections and other members' connections are removed; the creator's own connection is preserved. Only the connector's creator can call this endpoint. Requires the ShareConnectorToWorkspace workspace permission.

    DELETE /v1/connectors/{connector_id}/share

  • Destructive

    Unshare a connector from the current organization.

    Reverts an organization-shared connector back to a private, creator-owned connector. Organization-scoped connections and other members' connections are removed; the creator's own connection is preserved. Requires the ShareConnectorToOrg organization permission.

    DELETE /v1/connectors/{connector_id}/organization/share

  • Destructive

    Deactivate a connector for the current consumer (at organization, workspace or user level).

    Disable a connector for the calling consumer only.

    POST /v1/connectors/{connector_id}/{consumer_scope}/deactivate

  • Destructive

    Call Connector Tool (deprecated)

    Call a tool on an MCP connector.

    POST /v1/connectors/{connector_id_or_name}/tools/{tool_name}/call

  • Destructive

    Delete all user credentials for a connector.

    Delete all credentials configured at the user level for a given connector.

    DELETE /v1/connectors/{connector_id_or_name}/user/credentials

  • Destructive

    Delete credentials for a consumer.

    Delete connector credentials for a given consumer.

    DELETE /v1/connectors/{connector_id_or_name}/{consumer_scope}/credentials/{credentials_name}

  • Destructive

    Delete a connector.

    Delete a connector by its ID.

    DELETE /v1/connectors/{connector_id}#id

audio.voices

  • Read

    List all voices (deprecated)

    Offset pagination will not be supported anymore. Use GET /v2/audio/voices instead.

    GET /v1/audio/voices

  • Read

    Get voice details

    Get voice details (excluding sample)

    GET /v1/audio/voices/{voice_id}

  • Read

    Get voice sample audio

    Get the audio sample for a voice

    GET /v1/audio/voices/{voice_id}/sample

  • Read

    List voices, cursor-paginated

    List voices, cursor-paginated

    GET /v2/audio/voices

  • Write

    Create a new voice

    Create a new voice with a base64-encoded audio sample

    POST /v1/audio/voices

  • Write

    Update voice metadata

    Update voice metadata (name, gender, languages, age, tags, retention notice).

    PATCH /v1/audio/voices/{voice_id}

  • Destructive

    Delete a custom voice

    Delete a custom voice

    DELETE /v1/audio/voices/{voice_id}

workflows.executions

  • Read

    Get Workflow Execution

    Get Workflow Execution

    GET /v1/workflows/executions/{execution_id}

  • Read

    Get Workflow Execution History

    Get Workflow Execution History

    GET /v1/workflows/executions/{execution_id}/history

  • Read

    Query Workflow Execution

    Query Workflow Execution

    POST /v1/workflows/executions/{execution_id}/queries

  • Read

    Get Workflow Execution Trace Info

    Get Workflow Execution Trace Info

    GET /v1/workflows/executions/{execution_id}/trace/info

  • Read

    Get Workflow Execution Trace Otel

    Get Workflow Execution Trace Otel

    GET /v1/workflows/executions/{execution_id}/trace/otel

  • Read

    Get Workflow Execution Trace Summary

    Get Workflow Execution Trace Summary

    GET /v1/workflows/executions/{execution_id}/trace/summary

  • Read

    Get Workflow Execution Trace Events

    Get Workflow Execution Trace Events

    GET /v1/workflows/executions/{execution_id}/trace/events

  • Read

    Stream

    Stream

    GET /v1/workflows/executions/{execution_id}/stream

  • Read

    Get Workflow Execution Logs

    Retrieve logs for a workflow execution. Use `after`/`before`/`order` on the first request to set the time range and sort order; for the next pages pass the `cursor` from the previous response (it remembers the range and order).

    GET /v1/workflows/executions/{execution_id}/logs

  • Read

    Stream Workflow Execution Logs

    Stream logs for a workflow execution via SSE. Resume cursor comes from the `Last-Event-ID` header or `last_event_id` query param (header wins) and takes precedence over `after`; omit all to tail from the execution start.

    GET /v1/workflows/executions/{execution_id}/logs/stream

  • Write

    Signal Workflow Execution

    Signal Workflow Execution

    POST /v1/workflows/executions/{execution_id}/signals

  • Write

    Update Workflow Execution

    Update Workflow Execution

    POST /v1/workflows/executions/{execution_id}/updates

  • Destructive

    Terminate Workflow Execution

    Terminate Workflow Execution

    POST /v1/workflows/executions/{execution_id}/terminate

  • Destructive

    Batch Terminate Workflow Executions

    Batch Terminate Workflow Executions

    POST /v1/workflows/executions/terminate

  • Destructive

    Cancel Workflow Execution

    Cancel Workflow Execution

    POST /v1/workflows/executions/{execution_id}/cancel

  • Destructive

    Batch Cancel Workflow Executions

    Batch Cancel Workflow Executions

    POST /v1/workflows/executions/cancel

  • Destructive

    Reset Workflow

    Reset Workflow

    POST /v1/workflows/executions/{execution_id}/reset

workflows.metrics

  • Read

    Get Workflow Metrics

    Get comprehensive metrics for a specific workflow. Args: workflow_name: The name of the workflow type to get metrics for start_time: Optional start time filter (ISO 8601 format) end_time: Optional end time filter (ISO 8601 format) Returns: WorkflowMetrics: Dictionary containing metrics: - execution_count: Total number of executions - success_count: Number of successful executions - error_count: Number of failed/terminated executions - average_latency_ms: Average execution duration in milliseconds - retry_rate: Deprecated, always -1. Never measured retries; use error_count instead - latency_over_time: Time-series data of execution durations Example: GET /v1/workflows/MyWorkflow/metrics GET /v1/workflows/MyWorkflow/metrics?start_time=2025-01-01T00:00:00Z GET /v1/workflows/MyWorkflow/metrics?start_time=2025-01-01T00:00:00Z&end_time=2025-12-31T23:59:59Z

    GET /v1/workflows/{workflow_name}/metrics

workflows.runs

  • Read

    List Runs

    List Runs

    GET /v1/workflows/runs

  • Read

    Get Run

    Get Run

    GET /v1/workflows/runs/{run_id}

  • Read

    Get Run History

    Get Run History

    GET /v1/workflows/runs/{run_id}/history

workflows.schedules

  • Read

    Get Schedules

    Get Schedules

    GET /v1/workflows/schedules

  • Read

    Get Schedule

    Get Schedule

    GET /v1/workflows/schedules/{schedule_id}

  • Write

    Schedule Workflow

    Schedule Workflow

    POST /v1/workflows/schedules

  • Write

    Update Schedule

    Update Schedule

    PATCH /v1/workflows/schedules/{schedule_id}

  • Write

    Resume Schedule

    Resume Schedule

    POST /v1/workflows/schedules/{schedule_id}/resume

  • Write

    Trigger Schedule

    Trigger Schedule

    POST /v1/workflows/schedules/{schedule_id}/trigger

  • Destructive

    Unschedule Workflow

    Unschedule Workflow

    DELETE /v1/workflows/schedules/{schedule_id}

  • Destructive

    Pause Schedule

    Pause Schedule

    POST /v1/workflows/schedules/{schedule_id}/pause

events

  • Read

    Get Stream Events

    Stream workflow events as Server-Sent Events (SSE). One of `root_workflow_exec_id`, `parent_workflow_exec_id` or `workflow_exec_id` is required.

    GET /v1/workflows/events/stream

  • Read

    Get Workflow Events

    Get Workflow Events

    GET /v1/workflows/events/list

workflows.deployments

  • Read

    List Deployments

    List Deployments

    GET /v1/workflows/deployments

  • Read

    Get Deployment

    Get Deployment

    GET /v1/workflows/deployments/{name}

  • Read

    List Deployment Workers

    List Deployment Workers

    GET /v1/workflows/deployments/{name}/workers

  • Read

    Get Deployment Logs

    Retrieve logs for a deployment (across all of its workers). Use `after`/`before`/`order` on the first request to set the time range and sort order; for the next pages pass the `cursor` from the previous response (it remembers the range and order). `log_type=build` serves the managed build pipeline's output instead. It pages the same way, and a null `next_cursor` means the window is drained.

    GET /v1/workflows/deployments/{name}/logs

  • Read

    Stream Deployment Logs

    Stream logs for a deployment (all of its workers) via SSE. Resume cursor comes from the `Last-Event-ID` header or `last_event_id` query param (header wins) and takes precedence over `after`; omit all to tail from the deployment start.

    GET /v1/workflows/deployments/{name}/logs/stream

  • Write

    Unharden Deployment

    Unharden Deployment

    POST /v1/workflows/deployments/{deployment_id}/unharden

  • Write

    Create Deployment

    Create Deployment

    POST /v1/workflows/deployments

  • Write

    Update Deployment

    Update Deployment

    PATCH /v1/workflows/deployments/{name}

  • Write

    Start Deployment

    Start Deployment

    POST /v1/workflows/deployments/{name}/start

  • Write

    Restart Deployment

    Restart Deployment

    POST /v1/workflows/deployments/{name}/restart

  • Destructive

    Delete Deployment

    Delete Deployment

    DELETE /v1/workflows/deployments/{name}

  • Destructive

    Stop Deployment

    Stop Deployment

    POST /v1/workflows/deployments/{name}/stop

workflows

  • Read

    Get Workflows

    Get Workflows

    GET /v1/workflows

  • Read

    Get Workflow Registrations

    Get Workflow Registrations

    GET /v1/workflows/registrations

  • Read

    Get Workflow

    Get Workflow

    GET /v1/workflows/{workflow_identifier}

  • Read

    Get Workflow Registration

    Get Workflow Registration

    GET /v1/workflows/registrations/{workflow_registration_id}

  • Write

    Execute Workflow

    Execute Workflow

    POST /v1/workflows/{workflow_identifier}/execute

  • Write

    Execute Workflow Registration (deprecated)

    Execute Workflow Registration

    POST /v1/workflows/registrations/{workflow_registration_id}/execute

  • Write

    Bulk Archive Workflows

    Bulk Archive Workflows

    PUT /v1/workflows/archive

  • Write

    Bulk Unarchive Workflows

    Bulk Unarchive Workflows

    PUT /v1/workflows/unarchive

  • Write

    Archive Workflow

    Archive Workflow

    PUT /v1/workflows/{workflow_identifier}/archive

  • Write

    Unarchive Workflow

    Unarchive Workflow

    PUT /v1/workflows/{workflow_identifier}/unarchive

  • Destructive

    Update Workflow

    Update Workflow

    PUT /v1/workflows/{workflow_identifier}

beta.rag.ingestion_pipeline_configurations

  • Read

    List ingestion pipeline configurations

    For the current workspace, lists all of the registered ingestion pipeline configurations.

    GET /v1/rag/ingestion_pipeline_configurations

  • Write

    Register Config

    Register an ingestion configuration.

    PUT /v1/rag/ingestion_pipeline_configurations

  • Write

    Update Run Info

    Update Run Info

    PUT /v1/rag/ingestion_pipeline_configurations/{id}/run_info

beta.rag.search_indexes

  • Read

    Get Deployment Summaries

    Fetch all indexes available to a user

    GET /v1/rag/deployments

  • Write

    Register (or re-register) a search index

    Register (or re-register) a search index

    PUT /v1/rag/deployments

  • Destructive

    Unregister Deployment

    Delete all information about a deployment

    DELETE /v1/rag/deployments/{deployment_id}

  • Destructive

    Update Index Metrics

    Update the metrics for a given index

    PUT /v1/rag/deployments/{deployment_id}/metrics

beta.rag.managed_indexes

  • Read

    List managed indexes

    Lists all managed search indexes for the current workspace.

    GET /v1/rag/managed_indexes

  • Read

    Get a managed index

    Returns the managed search index with the given name.

    GET /v1/rag/managed_indexes/{index_name}

  • Read

    Search a managed index

    Runs an approximate-nearest-neighbor vector search over the index and returns matching chunks, closest-first.

    POST /v1/rag/managed_indexes/{index_name}/search

  • Read

    Navigate to adjacent chunks

    Returns the chunks adjacent to a position within a source, in reading order. NEXT fetches chunks at or after the end offset; PREVIOUS fetches chunks before the start offset. A 200 with an empty list means the source exists but no chunk falls in the requested direction; a 404 means the source has no chunks at all.

    POST /v1/rag/managed_indexes/{index_name}/navigate

  • Read

    Read chunks within a span

    Returns the chunks of a source whose span falls within [start_offset, end_offset). Either bound may be omitted to leave that side open. A 200 with an empty list means the source exists but no chunk falls in the range; a 404 means the source has no chunks at all.

    POST /v1/rag/managed_indexes/{index_name}/read

  • Read

    Grep for a pattern within a source

    Lexical substring match within a single source, in reading order. PHRASE mode matches the pattern literally (whitespace-sensitive, case-insensitive); TERM mode requires every whitespace-split token present in any order. A 200 with an empty list means the source exists but no chunk matched; a 404 means the source has no chunks at all.

    POST /v1/rag/managed_indexes/{index_name}/grep

  • Read

    Get a single chunk by id

    Returns a single chunk by its canonical id. A 404 means no chunk with that id exists in the index.

    GET /v1/rag/managed_indexes/{index_name}/chunks/{chunk_id}

  • Write

    Create a managed index

    Reserves a managed search index and starts asynchronous backing-table provisioning. Poll the returned Location until status is ready or failed.

    POST /v1/rag/managed_indexes

  • Write

    Update a managed index schema

    Records a new schema for the managed search index and applies it asynchronously. The index keeps serving its current schema until the new one is on disk; poll it until status is ready. Additive only: the new schema must keep every field the current one has.

    PUT /v1/rag/managed_indexes/{index_name}

  • Write

    Ingest documents into a managed index

    Validates and persists documents. Always returns 200; each document is reported as accepted or rejected in the response body.

    POST /v1/rag/managed_indexes/{index_name}/documents

  • Destructive

    Delete a managed index

    Marks the managed search index for deletion and returns it with status deleting. The backing table is dropped asynchronously; poll the index until it returns 404.

    DELETE /v1/rag/managed_indexes/{index_name}

  • Destructive

    Delete documents from a managed index

    Deletes the given documents by id. Returns the ids actually removed and, in `missing`, any requested ids that were not present.

    DELETE /v1/rag/managed_indexes/{index_name}/documents

beta.users

  • Read

    Get Identity

    Get Identity

    GET /v1/users/me

  • Read

    List Organizations

    List every organization the authenticated user is a member of. Identity-only: the caller need not have selected an organization, so this reads only the user and never scopes by the active org.

    GET /v1/users/me/organizations

  • Read

    List Workspaces

    List every workspace the authenticated user is a member of, across all their organizations, each tagged with the organization it belongs to.

    GET /v1/users/me/workspaces

  • Read

    Whoami

    Return the authenticated caller's identity. Principal-agnostic: resolves both users and service accounts.

    GET /v1/whoami

beta.admin.billing

  • Read

    Detailed Usage Query

    Query the organization's detailed usage for a required time range. Optional filters, caller-selected grouping and time buckets, pagination, aggregates, and distinct API-call counts are supported. The response contains usage quantities only; it does not include prices, currency, or calculated costs. For a fixed monthly report with pricing, use `GET /v1/admin/usage`.

    POST /v1/admin/usage/query

  • Read

    Get Rate Limits

    Get Rate Limits

    GET /v1/admin/rate-limit

  • Read

    Get Spend Limits

    Get usage, rate, and job limits for the Organization.

    GET /v1/admin/spend-limit

  • Read

    Monthly Usage and Pricing

    Return the organization's usage for a calendar month in a fixed, product-oriented format. The response includes the applicable price catalog and currency. For custom time ranges, filters, grouping, and pagination, use `POST /v1/admin/usage/query`.

    GET /v1/admin/usage

  • Destructive

    Update Spend Limits

    Update the Organization usage limit.

    POST /v1/admin/spend-limit

beta.admin.users

  • Read

    Get Users

    List Organization members and pending invitations.

    GET /v1/admin/users

  • Read

    Get Invite

    List pending Organization invitations.

    GET /v1/admin/users-invite

  • Read

    Get User

    Get details for an Organization member.

    GET /v1/admin/users/{user_id}

  • Read

    Get Roles

    List Organization and Workspace roles.

    GET /v1/admin/roles

  • Write

    Create Users

    Create Organization members.

    POST /v1/admin/users

  • Write

    Invite Users

    Invite users to the Organization.

    POST /v1/admin/users-invite

  • Destructive

    Delete Invite

    Delete Invite

    DELETE /v1/admin/users-invite/{invite_uuid}

  • Destructive

    Update User

    Update an Organization member's roles and product seats.

    PATCH /v1/admin/users/{user_id}

  • Destructive

    Delete User

    Remove a member from the Organization.

    DELETE /v1/admin/users/{user_id}

  • Destructive

    Deactivate User

    Deactivate a user whose email address is on one of the Organization's verified domains: remove them from every organization they belong to, which revokes their API keys, and end their sessions.

    POST /v1/admin/users/{user_id}/deactivate

beta.admin.workspaces

  • Read

    Get Workspaces

    List Workspaces in the Organization.

    GET /v1/admin/workspaces

  • Write

    Create Workspace

    Create a Workspace.

    POST /v1/admin/workspaces

  • Write

    Update Workspaces

    Update a Workspace.

    PATCH /v1/admin/workspaces/{workspace_uuid}

  • Write

    Add Users Workspaces

    Add members to a Workspace.

    POST /v1/admin/workspaces/{workspace_uuid}/add-users

  • Write

    Add Or Update Users Workspaces

    Add or update Workspace members.

    PATCH /v1/admin/workspaces/{workspace_uuid}/users

  • Destructive

    Delete Workspaces

    Archive a Workspace.

    DELETE /v1/admin/workspaces/{workspace_uuid}

  • Destructive

    Remove Users Workspaces

    Remove members from a Workspace.

    DELETE /v1/admin/workspaces/{workspace_uuid}/remove-users

beta.admin.audit-logs

  • Read

    Get Audit Logs

    List audit log entries for the Organization.

    GET /v1/admin/audit-logs

beta.admin.user-groups

  • Read

    Get User Groups

    Get all user groups across the organization.

    GET /v1/admin/user-groups

  • Read

    Get User Group

    Get a specific user group.

    GET /v1/admin/user-groups/{group_uuid}

  • Read

    Get User Group Members

    Get members of a user group.

    GET /v1/admin/user-groups/{group_uuid}/members

  • Read

    Get Group Workspace Assignments

    List workspace assignments for a user group.

    GET /v1/admin/user-groups/{group_uuid}/workspaces

  • Read

    Get Nested Groups Admin

    List the groups directly nested inside this group.

    GET /v1/admin/user-groups/{group_uuid}/nested

  • Write

    Create User Group

    Create a new user group.

    POST /v1/admin/user-groups

  • Write

    Provision Group To Workspace (deprecated)

    Deprecated: provision all users from a user group to a workspace with a specific role. Use `POST /user-groups/{group_uuid}/workspaces` with `role_names` to assign the group to a workspace, and `PATCH /user-groups/{group_uuid}/workspaces/{workspace_uuid}` to change the roles of an existing assignment.

    POST /v1/admin/user-groups/provision-workspace

  • Write

    Assign Users To Group

    Assign users to a user group.

    POST /v1/admin/user-groups/{group_uuid}/members

  • Write

    Assign Group To Workspace

    Assign a user group to a workspace.

    POST /v1/admin/user-groups/{group_uuid}/workspaces

  • Write

    Update Group Workspace Assignment

    Update the workspace role assignment for a user group.

    PATCH /v1/admin/user-groups/{group_uuid}/workspaces/{workspace_uuid}

  • Write

    Update User Group Organization Role

    Update the organization role for a user group.

    PATCH /v1/admin/user-groups/{group_uuid}/organization-role

  • Destructive

    Update User Group

    Update User Group

    PATCH /v1/admin/user-groups/{group_uuid}

  • Destructive

    Delete User Group

    Delete a user group.

    DELETE /v1/admin/user-groups/{group_uuid}

  • Destructive

    Remove Users From Group

    Remove users from a user group.

    DELETE /v1/admin/user-groups/{group_uuid}/members

  • Destructive

    Remove Group From Workspace

    Remove a user group from a workspace.

    DELETE /v1/admin/user-groups/{group_uuid}/workspaces/{workspace_uuid}

  • Destructive

    Set Nested Groups Admin

    Replace the set of groups directly nested inside this group.

    PATCH /v1/admin/user-groups/{group_uuid}/nested

beta.admin.api-keys

  • Read

    Get Api Keys

    List API keys for the Organization.

    GET /v1/admin/api-keys

  • Write

    Create Api Key

    Create a Workspace API key.

    POST /v1/admin/api-keys

  • Destructive

    Delete Api Key

    Delete an API key.

    DELETE /v1/admin/api-keys/{key_id}

beta.admin.scim

  • Read

    Get Scim Sync Run

    Retrieve an on-demand SCIM synchronization run for the Organization. Returns the run's lifecycle status along with the preview or result summary once the synchronization plan has been built.

    GET /v1/admin/scim/sync/{run_id}

  • Destructive

    Trigger Scim Sync

    Trigger an on-demand SCIM synchronization for the Organization. Requires SAML authentication to be enabled and the Organization to be in SCIM user provisioning mode. A dry run previews every change without applying it; a real run applies the categories selected in `sync_config`. Only one run may be active at a time — a conflicting request returns the already-active run.

    POST /v1/admin/scim/sync

beta.admin.vibe-work-analytics

  • Read

    Usage by user

    Get Vibe Work usage by user for a time range.

    GET /v1/admin/analytics/vibe/work/usage/by_user_stats

  • Read

    Usage by agent

    Get Vibe Work usage by agent for a time range.

    GET /v1/admin/analytics/vibe/work/usage/by_agent_stats

  • Read

    Usage over time

    Get Vibe Work usage over time.

    GET /v1/admin/analytics/vibe/work/usage/by_time_stats

beta.admin.vibe-code-analytics

  • Read

    Usage by workspace

    Get Vibe Code usage for a Workspace.

    GET /v1/admin/analytics/vibe/code/usage/by_workspace

  • Read

    Usage by organization

    Get Vibe Code usage for the Organization.

    GET /v1/admin/analytics/vibe/code/usage/by_organization

responses

  • Read

    Count Input Tokens

    Count response input tokens. Count the input tokens for a Responses request without generating a response. The count includes the supplied conversation, instructions, and tool definitions. Use the same input, instructions, and tools that you plan to send when creating a response. For multi-turn conversations, include prior output items and function results in input.

    POST /v1/responses/input_tokens

  • Write

    Create Response

    Create a response. Generate a model response from text or image inputs. The response can include text, reasoning, and function calls. Set stream to true to receive Server-Sent Events. For multi-turn conversations, send the full history in input, including prior output items and function results. Responses are not stored. Only client-executed function tools are supported.

    POST /v1/responses

See How connections work for access and permissions, or browse all integrations.

Reference date: October 29, 2026. Mistral AI API docs.