Skip to content
Prompts

GEThttps://core-api.heysadie.ai/prompts

limit offset includeGlobal search type success data prompts id name prompt createdAt updatedAt total metadata timestamp version path error code message details field

List prompts

Try it in the API Explorer

Example request

Terminal
curl "https://core-api.heysadie.ai/prompts?limit=10&offset=0" \
  -H "Authorization: ApiKey YOUR_API_KEY"

Authentication

Authenticate with an API key in the Authorization header using the ApiKey scheme — see Authentication for how keys work and where to get them.

Authorizationstringrequired

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

X-Tenant-Idstring (uuid)optional

Required when authenticating with an organization key — selects the tenant the request acts on. Omit with tenant keys.

Request

Query parameters

limitstringoptional

Max number of records to return

offsetstringoptional

Number of records to skip

includeGlobalstringoptional

Defaults to 'false' — only returns prompts owned by the requesting tenant. Pass 'true' to also include global prompts (tenantId IS NULL).

searchstringoptional

Search prompts by name (case-insensitive partial match)

typestringoptional

Filter by prompt type: 'voice', 'chat', or 'whisper_summary'. Omitted → all types.

Responses

200
successbooleanrequired
dataobjectoptional
Show 2 child properties
promptsobject[]required
Show 6 item properties
idstringrequired
namestring | nulloptional
promptstringrequired
typestringoptional
createdAtstring (date-time) | string (date) | number | nullrequired
updatedAtstring (date-time) | string (date) | number | nullrequired
totalnumberrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
400
successbooleanrequired
errorobjectoptional
Show 3 child properties
codeenumrequired
Allowed values:"VALIDATION_ERROR"
messagestringrequired
detailsobject[]optional
Show 2 item properties
fieldstringrequired
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
401
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"UNAUTHORIZED"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
403
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"FORBIDDEN"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
404
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"RESOURCE_NOT_FOUND"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
500
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional