Type Alias components

type components = {
    headers: never;
    parameters: never;
    pathItems: never;
    requestBodies: never;
    responses: {
        BadRequest: {
            content: {
                "application/json": components["schemas"]["ErrorResponse"];
            };
            headers: { [name: string]: unknown };
        };
        InternalServerError: {
            content: {
                "application/json": components["schemas"]["ErrorResponse"];
            };
            headers: { [name: string]: unknown };
        };
        Unauthorized: {
            content: {
                "application/json": components["schemas"]["ErrorResponse"];
            };
            headers: { [name: string]: unknown };
        };
    };
    schemas: {
        Application: {
            bundleVersion?: string;
            intentBaseUrl?: string;
            key?: string;
            name?: string;
            resource?: { id?: string; type?: "dataset" };
            schemaDescriptorId?: string;
            title?: string;
        };
        Capabilities: {
            features?: components["schemas"]["FeatureOverrides"];
            read?: components["schemas"]["Capability"];
            write?: components["schemas"]["Capability"];
        };
        Capability: boolean
        | components["schemas"]["CapabilityPreset"];
        CapabilityPreset: { preset: "minimal" | "standard" };
        ChatRequest: {
            application?: components["schemas"]["Application"];
            config?: components["schemas"]["Config"];
            format: "markdown" | "directives";
            messages: components["schemas"]["Message"][];
            stream: boolean;
        };
        ChatResponse: { applicationKey?: string; text?: string };
        Config: {
            capabilities?: components["schemas"]["Capabilities"];
            filter?: components["schemas"]["Filter"];
            instruction?: string;
            perspectives?: components["schemas"]["Perspectives"];
            userMessageContext?: { [key: string]: string };
        };
        ErrorResponse: {
            details?: string;
            error: string;
            issues?: components["schemas"]["ValidationIssue"][];
        };
        FeatureOverrides: { webSearch?: boolean };
        Filter: { read?: string; write?: string };
        Message: {
            content: string;
            id?: string;
            name?: string;
            role: "user" | "assistant" | "system";
        };
        Perspectives: { read?: string[]; write?: string };
        PromptRequest: {
            config?: components["schemas"]["Config"];
            format: "markdown" | "directives";
            instructions?: string;
            message: string;
            organizationId: string;
        };
        ValidationIssue: { code?: string; message?: string; path?: string[] };
    };
}

Index

Properties

headers parameters pathItems requestBodies responses schemas

Properties

headers

headers: never

parameters

parameters: never

pathItems

pathItems: never

requestBodies

requestBodies: never

responses

responses: {
    BadRequest: {
        content: { "application/json": components["schemas"]["ErrorResponse"] };
        headers: { [name: string]: unknown };
    };
    InternalServerError: {
        content: { "application/json": components["schemas"]["ErrorResponse"] };
        headers: { [name: string]: unknown };
    };
    Unauthorized: {
        content: { "application/json": components["schemas"]["ErrorResponse"] };
        headers: { [name: string]: unknown };
    };
}

Type declaration

BadRequest: {
content: { "application/json": components["schemas"]["ErrorResponse"] };
headers: { [name: string]: unknown };
}

Description

Bad Request - Request validation failed

content: { "application/json": components["schemas"]["ErrorResponse"] }

application/json: components["schemas"]["ErrorResponse"]

Example

{
         *       "error": "Invalid request",
         *       "details": "Request body validation failed",
         *       "issues": [
         *         {
         *           "code": "invalid_type",
         *           "path": [
         *             "messages"
         *           ],
         *           "message": "Required"
         *         }
         *       ]
         *     }

headers: { [name: string]: unknown }

InternalServerError: {
content: { "application/json": components["schemas"]["ErrorResponse"] };
headers: { [name: string]: unknown };
}
Description
Internal Server Error
- content: { "application/json": components["schemas"]["ErrorResponse"] }
  - application/json: components["schemas"]["ErrorResponse"]
    Example
    { * "error": "Internal Server Error", * "details": "An unexpected error occurred" * }
- headers: { [name: string]: unknown }
Unauthorized: {
content: { "application/json": components["schemas"]["ErrorResponse"] };
headers: { [name: string]: unknown };
}
Description
Unauthorized - Missing or invalid authentication token
- content: { "application/json": components["schemas"]["ErrorResponse"] }
  - application/json: components["schemas"]["ErrorResponse"]
    Example
    { * "error": "Unauthorized", * "details": "Missing authorization token" * }
- headers: { [name: string]: unknown }

schemas

schemas: {
    Application: {
        bundleVersion?: string;
        intentBaseUrl?: string;
        key?: string;
        name?: string;
        resource?: { id?: string; type?: "dataset" };
        schemaDescriptorId?: string;
        title?: string;
    };
    Capabilities: {
        features?: components["schemas"]["FeatureOverrides"];
        read?: components["schemas"]["Capability"];
        write?: components["schemas"]["Capability"];
    };
    Capability: boolean
    | components["schemas"]["CapabilityPreset"];
    CapabilityPreset: { preset: "minimal" | "standard" };
    ChatRequest: {
        application?: components["schemas"]["Application"];
        config?: components["schemas"]["Config"];
        format: "markdown" | "directives";
        messages: components["schemas"]["Message"][];
        stream: boolean;
    };
    ChatResponse: { applicationKey?: string; text?: string };
    Config: {
        capabilities?: components["schemas"]["Capabilities"];
        filter?: components["schemas"]["Filter"];
        instruction?: string;
        perspectives?: components["schemas"]["Perspectives"];
        userMessageContext?: { [key: string]: string };
    };
    ErrorResponse: {
        details?: string;
        error: string;
        issues?: components["schemas"]["ValidationIssue"][];
    };
    FeatureOverrides: { webSearch?: boolean };
    Filter: { read?: string; write?: string };
    Message: {
        content: string;
        id?: string;
        name?: string;
        role: "user" | "assistant" | "system";
    };
    Perspectives: { read?: string[]; write?: string };
    PromptRequest: {
        config?: components["schemas"]["Config"];
        format: "markdown" | "directives";
        instructions?: string;
        message: string;
        organizationId: string;
    };
    ValidationIssue: { code?: string; message?: string; path?: string[] };
}

Type declaration

Application: {
    bundleVersion?: string;
    intentBaseUrl?: string;
    key?: string;
    name?: string;
    resource?: { id?: string; type?: "dataset" };
    schemaDescriptorId?: string;
    title?: string;
}
Description
Target Sanity application configuration
- OptionalbundleVersion?: string
  Description
  Bundle version
- OptionalintentBaseUrl?: string
  Format: uri
  Description
  Base URL for the Sanity Studio
  Example
```
https://your-studio.sanity.studio
```
- Optionalkey?: string
  Description
  Application key in format "projectId.datasetName"
  Example
```
abc123.production
```
- Optionalname?: string
  Description
  Application name
- Optionalresource?: { id?: string; type?: "dataset" }
  - Optionalid?: string
    Description
    Resource ID in format "projectId.datasetName"
    Example
    abc123.production
  - Optionaltype?: "dataset"
    Description
    Resource type
- OptionalschemaDescriptorId?: string
  Description
  Schema descriptor ID
- Optionaltitle?: string
  Description
  Application title
Capabilities: {
    features?: components["schemas"]["FeatureOverrides"];
    read?: components["schemas"]["Capability"];
    write?: components["schemas"]["Capability"];
}
Description
Agent capabilities that control what operations are allowed. Each capability can be a boolean or an object with a preset.
Example
```
{
     *       "read": true,
     *       "write": false
     *     }
```
Capability: boolean | components["schemas"]["CapabilityPreset"]
Description
A capability can be: - true: Full access (standard preset) - false: No access - { preset: 'minimal' | 'standard' }: Explicit preset selection
CapabilityPreset: { preset: "minimal" | "standard" }
- preset: "minimal" | "standard"
  Description
  For read capability: - minimal: Basic queries only (no bulk document analysis) - standard: All read tools including bulk analysis
```
For write capability:
- minimal: Basic mutations only (no bulk mutations)
- standard: All write tools including bulk mutations
```
ChatRequest: {
    application?: components["schemas"]["Application"];
    config?: components["schemas"]["Config"];
    format: "markdown" | "directives";
    messages: components["schemas"]["Message"][];
    stream: boolean;
}
- Optionalapplication?: components["schemas"]["Application"]
- Optionalconfig?: components["schemas"]["Config"]
- format: "markdown" | "directives"
  Description
  Controls how directives in the response are formatted. - markdown (default): Directives are resolved server-side into standard markdown (e.g., links with titles). - directives: Raw directive syntax is preserved (e.g., ::document{id="doc-id"}), useful for clients that render custom UI components.
  Default
```
markdown
@enum {string}
```
- messages: components["schemas"]["Message"][]
  Description
  Array of message objects
- stream: boolean
  Description
  Enable or disable streaming responses
  Default
```
true
```
ChatResponse: { applicationKey?: string; text?: string }
Description
JSON response when streaming is disabled
- OptionalapplicationKey?: string
  Description
  The application key used for this conversation
- Optionaltext?: string
  Description
  The agent's response text
Config: {
    capabilities?: components["schemas"]["Capabilities"];
    filter?: components["schemas"]["Filter"];
    instruction?: string;
    perspectives?: components["schemas"]["Perspectives"];
    userMessageContext?: { [key: string]: string };
}
Description
Agent configuration. Controls behavior, capabilities, and document access.
- Optionalcapabilities?: components["schemas"]["Capabilities"]
- Optionalfilter?: components["schemas"]["Filter"]
- Optionalinstruction?: string
  Description
  Custom instruction string to include in the system prompt
  Example
```
You are a helpful content assistant.
```
- Optionalperspectives?: components["schemas"]["Perspectives"]
- OptionaluserMessageContext?: { [key: string]: string }
  Description
  Key-value pairs appended to each user message as XML tags. Each key becomes an XML tag with the value as content. Example: { "slack-channel": "#marketing" } renders as #marketing
  Example
```
{
       *       "slack-channel": "#marketing",
       *       "user-role": "editor"
       *     }
```
ErrorResponse: {
    details?: string;
    error: string;
    issues?: components["schemas"]["ValidationIssue"][];
}
- Optionaldetails?: string
  Description
  Human-readable error description
  Example
```
Request body validation failed
```
- error: string
  Description
  Error type
  Example
```
Invalid request
```
- Optionalissues?: components["schemas"]["ValidationIssue"][]
  Description
  Validation issues (when applicable)
FeatureOverrides: { webSearch?: boolean }
Description
Explicit feature overrides applied on top of capability-derived defaults. When not specified, features use values derived from read/write capability presets.
- OptionalwebSearch?: boolean
  Description
  Override web search availability. By default, web search is enabled when read capability is 'standard'.
Filter: { read?: string; write?: string }
Description
GROQ filter expressions for document access control
- Optionalread?: string
  Description
  GROQ boolean expression for document visibility. Documents matching this filter are visible to the agent.
  Example
```
_type in ['post', 'author']
```
- Optionalwrite?: string
  Description
  GROQ boolean expression for mutation permissions. Documents matching this filter can be mutated.
  Example
```
_type == 'post'
```
Message: {
    content: string;
    id?: string;
    name?: string;
    role: "user" | "assistant" | "system";
}
- content: string
  Description
  The message content
- Optionalid?: string
  Description
  Optional unique identifier for the message
- Optionalname?: string
  Description
  Optional name for the message sender
- role: "user" | "assistant" | "system"
  Description
  The role of the message sender
Perspectives: { read?: string[]; write?: string }
Description
Perspective locking configuration. Controls which document perspectives the agent can read from and write to. Values are Sanity perspective IDs: 'drafts', 'published', 'raw', or release/bundle IDs.
- Optionalread?: string[]
  Description
  Allowed read perspectives. When set, query tools can only use these perspectives. If the agent tries to use a disallowed perspective, the request is rejected with an error.
  Example
```
[
      "drafts",
      "published"
    ]
```
- Optionalwrite?: string
  Description
  The write perspective. When set, new documents are created in this perspective and mutations are restricted to documents whose ID matches it.
  Example
```
drafts
```
PromptRequest: {
    config?: components["schemas"]["Config"];
    format: "markdown" | "directives";
    instructions?: string;
    message: string;
    organizationId: string;
}
- Optionalconfig?: components["schemas"]["Config"]
- format: "markdown" | "directives"
  Description
  Controls how directives in the response are formatted. - markdown (default): Directives are resolved server-side into standard markdown. - directives: Raw directive syntax is preserved for clients that render custom UI.
  Default
```
markdown
@enum {string}
```
- Optionalinstructions?: string
  Description
  Custom instructions for the agent
  Example
```
Be concise and use bullet points
```
- message: string
  Description
  The prompt message
  Example
```
Summarize my latest blog posts
```
- organizationId: string
  Description
  Your Sanity organization ID
  Example
```
abc123
```
ValidationIssue: { code?: string; message?: string; path?: string[] }
- Optionalcode?: string
  Description
  Error code
  Example
```
invalid_type
```
- Optionalmessage?: string
  Description
  Error message
  Example
```
Required
```
- Optionalpath?: string[]
  Description
  Path to the invalid field
  Example
```
[
      "messages"
    ]
```

Type Alias components

Index

Properties

Properties

headers

parameters

pathItems

requestBodies

responses

Type declaration

BadRequest: { content: { "application/json": components["schemas"]["ErrorResponse"] }; headers: { [name: string]: unknown };}

Description

content: { "application/json": components["schemas"]["ErrorResponse"] }

application/json: components["schemas"]["ErrorResponse"]

Example

headers: { [name: string]: unknown }

InternalServerError: { content: { "application/json": components["schemas"]["ErrorResponse"] }; headers: { [name: string]: unknown };}

Description

content: { "application/json": components["schemas"]["ErrorResponse"] }

application/json: components["schemas"]["ErrorResponse"]

Example

headers: { [name: string]: unknown }

Unauthorized: { content: { "application/json": components["schemas"]["ErrorResponse"] }; headers: { [name: string]: unknown };}

Description

content: { "application/json": components["schemas"]["ErrorResponse"] }

application/json: components["schemas"]["ErrorResponse"]

Example

headers: { [name: string]: unknown }

schemas

Type declaration

Application: { bundleVersion?: string; intentBaseUrl?: string; key?: string; name?: string; resource?: { id?: string; type?: "dataset" }; schemaDescriptorId?: string; title?: string;}

Description

OptionalbundleVersion?: string

Description

OptionalintentBaseUrl?: string

Description

Example

Optionalkey?: string

Description

Example

Optionalname?: string

Description

Optionalresource?: { id?: string; type?: "dataset" }

Optionalid?: string

Description

Example

Optionaltype?: "dataset"

Description

OptionalschemaDescriptorId?: string

Description

Optionaltitle?: string

Description

Capabilities: { features?: components["schemas"]["FeatureOverrides"]; read?: components["schemas"]["Capability"]; write?: components["schemas"]["Capability"];}

Description

Example

Capability: boolean | components["schemas"]["CapabilityPreset"]

Description

CapabilityPreset: { preset: "minimal" | "standard" }

preset: "minimal" | "standard"

Description

ChatRequest: { application?: components["schemas"]["Application"]; config?: components["schemas"]["Config"]; format: "markdown" | "directives"; messages: components["schemas"]["Message"][]; stream: boolean;}

Optionalapplication?: components["schemas"]["Application"]

Optionalconfig?: components["schemas"]["Config"]

format: "markdown" | "directives"

Description

Default

messages: components["schemas"]["Message"][]

Description

stream: boolean

Description

Default

ChatResponse: { applicationKey?: string; text?: string }

Description

OptionalapplicationKey?: string

Description

Optionaltext?: string

Description

Config: { capabilities?: components["schemas"]["Capabilities"]; filter?: components["schemas"]["Filter"]; instruction?: string; perspectives?: components["schemas"]["Perspectives"]; userMessageContext?: { [key: string]: string };}

Description

Optionalcapabilities?: components["schemas"]["Capabilities"]

BadRequest: {
content: { "application/json": components["schemas"]["ErrorResponse"] };
headers: { [name: string]: unknown };
}

InternalServerError: {
content: { "application/json": components["schemas"]["ErrorResponse"] };
headers: { [name: string]: unknown };
}

Unauthorized: {
content: { "application/json": components["schemas"]["ErrorResponse"] };
headers: { [name: string]: unknown };
}

Application: {
bundleVersion?: string;
intentBaseUrl?: string;
key?: string;
name?: string;
resource?: { id?: string; type?: "dataset" };
schemaDescriptorId?: string;
title?: string;
}

`Optional`bundleVersion?: string

`Optional`intentBaseUrl?: string

`Optional`key?: string

`Optional`name?: string

`Optional`resource?: { id?: string; type?: "dataset" }

`Optional`id?: string

`Optional`type?: "dataset"

`Optional`schemaDescriptorId?: string

`Optional`title?: string

Capabilities: {
features?: components["schemas"]["FeatureOverrides"];
read?: components["schemas"]["Capability"];
write?: components["schemas"]["Capability"];
}

ChatRequest: {
application?: components["schemas"]["Application"];
config?: components["schemas"]["Config"];
format: "markdown" | "directives";
messages: components["schemas"]["Message"][];
stream: boolean;
}

`Optional`application?: components["schemas"]["Application"]

`Optional`config?: components["schemas"]["Config"]

`Optional`applicationKey?: string

`Optional`text?: string

Config: {
capabilities?: components["schemas"]["Capabilities"];
filter?: components["schemas"]["Filter"];
instruction?: string;
perspectives?: components["schemas"]["Perspectives"];
userMessageContext?: { [key: string]: string };
}

`Optional`capabilities?: components["schemas"]["Capabilities"]

`Optional`filter?: components["schemas"]["Filter"]

`Optional`instruction?: string

`Optional`perspectives?: components["schemas"]["Perspectives"]

`Optional`userMessageContext?: { [key: string]: string }

ErrorResponse: {
details?: string;
error: string;
issues?: components["schemas"]["ValidationIssue"][];
}

`Optional`details?: string

`Optional`issues?: components["schemas"]["ValidationIssue"][]

`Optional`webSearch?: boolean

`Optional`read?: string

`Optional`write?: string

Message: {
content: string;
id?: string;
name?: string;
role: "user" | "assistant" | "system";
}

`Optional`id?: string

`Optional`name?: string

`Optional`read?: string[]

`Optional`write?: string

PromptRequest: {
config?: components["schemas"]["Config"];
format: "markdown" | "directives";
instructions?: string;
message: string;
organizationId: string;
}

`Optional`config?: components["schemas"]["Config"]

`Optional`instructions?: string

`Optional`code?: string

`Optional`message?: string

`Optional`path?: string[]