Skip to main content
POST
Create recipe

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Request body schema.

name
string
required

Recipe name.

Required string length: 1 - 255
description
string
required

Recipe description.

Required string length: 1 - 1000
category
enum<string>
required

Recipe category.

Available options:
other,
classification,
cleaning,
marketing,
sales,
event,
copywriting
isPublic
boolean
required

Whether the recipe is public.

placeholders
Placeholders · object[]
required

Recipe placeholders.

expression
string
required

Recipe expression.

kind
enum<string>
required

Expression kind.

Available options:
jsExpression,
templateExpression
instructTo
enum<string>
required

Instruction target.

Available options:
ai,
none

Response

Create recipe

The response is of type object.