POST /data/projects/{project_id}/episodes

Create an episode in a project. Provide name and description. Status is optional.

Path parameters

  • project_id Required
application/json

Body Required

  • name string Required
  • description string Required
  • status string

Responses

  • 201 application/json

    Episode created

    Hide response attributes Show response attributes object
    • id string(uuid)
    • name string
    • project_id string(uuid)
    • description string
    • status string
POST /data/projects/{project_id}/episodes
curl -X POST "http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "EP01",
  "description": "A short description of the episode",
  "status": "running"
}'
import requests

url = "http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
}
params = {}
payload = {
    "name": "EP01",
    "description": "A short description of the episode",
    "status": "running"
}

response = requests.post(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())
curl \
 --request POST 'http://api.example.com/data/projects/a24a6ea4-ce75-4665-a070-57453082c25/episodes' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"name":"EP01","description":"A short description of the episode","status":"running"}'
Request examples
{
  "name": "EP01",
  "description": "A short description of the episode",
  "status": "running"
}
Response examples (201)
{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "EP01",
  "project_id": "b24a6ea4-ce75-4665-a070-57453082c25",
  "description": "A short description of the episode",
  "status": "running"
}