Skip to main content
POST
Create goal

Authorizations

Authorization
string
header
required

Production keys begin with darwin_. Isolated sandbox keys begin with darwin_test_. Create keys in Developer settings.

Headers

Idempotency-Key
string

Use the same key to safely retry the same goal creation request.

Required string length: 1 - 200

Body

application/json
intent
string
required
Required string length: 1 - 20000
aiId
string
title
string
Maximum string length: 160
mode
enum<string>

The workflow view for shared Darwin work resources.

Available options:
BUY,
SELL,
CHAT
lifecycleStatus
enum<string>
default:ACTIVE
Available options:
DRAFT,
ACTIVE
visibility
enum<string>
Available options:
PUBLIC,
RESTRICTED,
PRIVATE
accessPolicyId
string
cadence
object
targeting
object
context
object
capabilityIds
string[]
Maximum array length: 100

Response

The new goal.

goal
object
required