Skip to main content
POST
/
api
/
v1
/
beam
/
datasets
Create Dataset Handler
curl --request POST \
  --url https://api.allium.so/api/v1/beam/datasets \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "type": "postgres",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
Creates a new dataset. Dataset names must be unique per user. Request body: 
{
  "name": "my-contracts"
}
FieldRequiredDescription
nameYesUnique name for the dataset
curl -X POST https://api.allium.so/api/v1/beam/datasets \
  -H "X-API-Key: ${ALLIUM_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "name": "my-contracts" }'
Response: 
{
  "id": "a1b2c3d4",
  "name": "my-contracts",
  "type": "postgres",
  "created_at": "2024-01-15T10:00:00Z",
  "updated_at": "2024-01-15T10:00:00Z"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
name
string
required

Response

Successful Response

​
id
string
required
​
name
string
required
​
type
string
default:postgres
Allowed value: "postgres"
​
created_at
string<date-time> | null
​
updated_at
string<date-time> | null