Skip to main content
POST
/
sources
Create a source
curl --request POST \
  --url https://api.deck.co/v2/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "website": {
    "url": "<string>"
  },
  "name": "<string>"
}
'
{
  "id": "<string>",
  "object": "<string>",
  "name": "<string>",
  "type": "<string>",
  "website": {
    "url": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "request_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Secret key (sk_live_...)

Body

Request body for creating a new 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.

​
name
null | string

Display name for the source.

Response

An existing source with the same URL was returned. Sources are deduplicated by their normalized URL, so creating a source that already exists returns the existing source with 200 instead of 201.

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

​
id
string
required

Unique identifier for the source, prefixed with src_.

​
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.

​
updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated.

​
request_id
string
required

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