Skip to main content
POST
/
definitions
Create a new Definition
curl --request POST \
  --url https://commerce.driv.ly/api/definitions \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "name": "<string>",
  "definition": "<string>",
  "model": "gpt-3.5-turbo"
}
'
{
  "doc": {
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "name": "<string>",
    "definition": "<string>",
    "model": "gpt-3.5-turbo"
  },
  "message": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { definitions } from '@drivly/commerce'

const sdk = new SDK(...)

const definitions = await sdk.definitions.create(data: definitions): Promise<definitions>

Authorizations

​
Authorization
string
header
required

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

Body

application/json
​
updatedAt
string
required
​
createdAt
string
required
​
name
string | null
​
definition
string | null
​
model
enum<string> | null
Available options:
gpt-3.5-turbo,
gpt-4,
gpt-4-0613,
XState,
gpt-4-0314,
XML,
gpt-4-1106-preview

Response

200 - application/json

ok

​
doc
Definition · object
required
​
message
string
required