v1

latestOpenAPI 3.0.3Apache 2.02026-07-1372170520.1 KB

Manage Assistants

Check assistant status

Get the status of an assistant.

For guidance and examples, see Manage assistants

get/assistants/{assistant_name}

Path parameters

assistant_namestring required

The name of the assistant to get a status on.

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Response

Poll request successful.

namestring required

The name of the assistant. Resource name must be 1-63 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or -.

instructionsstring nullable

Guidance applied to all responses generated by the assistant.

metadataobject nullable

Optional metadata associated with the assistant. Metadata is a JSON object that can store custom organizational data, tags, and attributes.

statusstring required

The current operational status of the assistant.

hoststring

The host where the assistant is deployed.

regionstring

The region where the assistant is deployed.

created_atstring date-time

The timestamp when the assistant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

updated_atstring date-time

The timestamp of the most recent update to the assistant, in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example response

{
  "name": "example-assistant",
  "instructions": "Answer questions with clear, helpful answers. Keep the tone friendly and easy to follow.",
  "metadata": {
    "role": "Customer Support Helper",
    "team": "Operations"
  },
  "host": "https://prod-1-data.ke.pinecone.io",
  "created_at": "2025-10-01T12:30:00Z",
  "updated_at": "2025-10-01T12:45:00Z"
}