Skip to main content
PATCH
Update a source

Authorizations

Authorization
string
header
required

Secret key (sk_live_...)

Headers

Idempotency-Key
string

Optional key that makes the request idempotent. Retrying with the same key returns the original response instead of repeating the operation; keys expire after 24 hours. Any string up to 256 characters. See Idempotency.

Maximum string length: 256
Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

source_id
string
required

Unique identifier for the source (prefixed with src_).

Pattern: ^src_
Example:

"src_AbC123xYz456"

Body

Request body for updating a source. Only include fields you want to change.

name
null | string

Updated display name.

url
null | string

Updated website URL.

headers
null | object

Optional. Replaces the full set of custom headers on the source. Send null to remove all headers. Omit to leave them unchanged. Available on Enterprise plans as an add-on.

Response

OK

A source object. Sources are websites or services that agents connect to.

id
string
required

Unique identifier for the source, prefixed with src_.

Pattern: ^src_
Example:

"src_AbC123xYz456"

object
string
required

Always source.

name
null | string
required

Display name for the source.

type
string
required

The source type. website is currently the only supported type; it defaults to website if omitted.

website
object
required

Website configuration for the source.

created_at
string<date-time>
required

ISO 8601 timestamp of when the resource was created.

Example:

"2026-08-24T12:00:00Z"

updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated.

Example:

"2026-08-24T12:00:00Z"

request_id
string
required

Unique identifier for the API request. Include this when contacting support.

headers
null | object

Request headers configured on the source. Omitted when none are set.