Skip to main content
POST
/
catchAll
/
datasets
Create dataset
curl --request POST \
  --url https://catchall.newscatcherapi.com/catchAll/datasets \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "My Portfolio",
  "description": "Companies in our investment portfolio",
  "entity_ids": [
    "854198fa-f702-49db-a381-0427fa87f173",
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  ]
}
'
{
  "id": "ccabb755-afc2-4047-b84c-78d1f23d49b2",
  "organization_id": "e5d9e9b0-e415-4941-8ef0-916c5ee56207",
  "name": "My Portfolio",
  "description": "Companies in our investment portfolio",
  "entity_count": 4,
  "latest_status": "ready",
  "created_by_user_id": "870e258e-12ec-4a47-8656-e7a43b0265b3",
  "created_at": "2026-04-08T15:21:36.026993",
  "updated_at": "2026-04-08T15:21:36.027001"
}

Authorizations

x-api-key
string
header
required

API key for authentication.

Body

application/json
name
string
required

Name for the dataset.

Minimum string length: 1
Example:

"My Portfolio"

description
string

Optional description.

Example:

"Companies in our investment portfolio"

entity_ids
string<uuid>[]

IDs of existing entities to include in the dataset. All IDs must belong to the authenticated organization. If any ID is invalid or not found, the request fails with 400.

Example:
[
"854198fa-f702-49db-a381-0427fa87f173",
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
]

Response

Full dataset object with metadata and current status.

id
string<uuid>
required

Unique identifier of the dataset.

Example:

"ccabb755-afc2-4047-b84c-78d1f23d49b2"

organization_id
string<uuid>
required

Organization that owns this dataset.

Example:

"e5d9e9b0-e415-4941-8ef0-916c5ee56207"

name
string
required

Dataset name.

Example:

"My Portfolio"

description
string | null

Optional description.

Example:

"Companies in our investment portfolio"

entity_count
integer
default:0

Total number of entities in this dataset.

Example:

4

latest_status
enum<string>

Processing status of a dataset.

  • pending: Dataset created, entities queued for enrichment.
  • enriching: Entities are being enriched.
  • ready: All entities enriched and indexed — ready for use in jobs.
  • failed: One or more entity enrichments failed.
Available options:
pending,
enriching,
ready,
failed
created_by_user_id
string<uuid>

ID of the user who created this dataset.

Example:

"870e258e-12ec-4a47-8656-e7a43b0265b3"

created_at
string<date-time>

ISO 8601 timestamp of when the dataset was created. Returned without timezone offset (server-local time).

Example:

"2026-04-08T15:21:36.026993"

updated_at
string<date-time>

ISO 8601 timestamp of when the dataset was last updated. Returned without timezone offset (server-local time).

Example:

"2026-04-08T15:21:38.401148"