Get prompt draft version

curl --request GET \
  --url 'https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-prompt/versions/9c59b2df-5d5f-4c9e-a070-9ac3c2b1b24e/public' \
  --header 'Authorization: Bearer fini_your_api_key'

{
  "id": "<string>",
  "promptId": "<string>",
  "botId": "<string>",
  "versionNumber": 123,
  "status": {},
  "parentVersionId": {},
  "publishedAt": {},
  "hcPlanningPrompt": [
    {}
  ],
  "hcGuidelinePrompt": [
    {}
  ],
  "hcChannelPrompt": [
    {}
  ]
}

GET

bots

{id}

hc-prompt

versions

{versionId}

public

curl --request GET \
  --url 'https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-prompt/versions/9c59b2df-5d5f-4c9e-a070-9ac3c2b1b24e/public' \
  --header 'Authorization: Bearer fini_your_api_key'

{
  "id": "<string>",
  "promptId": "<string>",
  "botId": "<string>",
  "versionNumber": 123,
  "status": {},
  "parentVersionId": {},
  "publishedAt": {},
  "hcPlanningPrompt": [
    {}
  ],
  "hcGuidelinePrompt": [
    {}
  ],
  "hcChannelPrompt": [
    {}
  ]
}

Returns one stored prompt lifecycle version for an agent. Use this route to review the complete prompt arrays and metadata for a draft before publishing it. Unlike Get prompts, this route does not merge the current prompt with the workspace template. It returns the exact stored version identified by versionId.

Headers

string

required

Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs read scope.

Path parameters

string

required

Agent ID that owns the prompt version.

string

required

Prompt lifecycle version ID returned by Create prompt draft version.

Response

string

Prompt lifecycle version ID.

string

Prompt record ID this lifecycle version is based on.

string

Agent ID that owns the version.

number

Agent-specific lifecycle version number.

DRAFT | PUBLISHED | ARCHIVED

Current lifecycle status.

string | null

Published lifecycle version this draft was created from.

datetime | null

Publication timestamp. Draft versions return null.

PromptSection[]

Exact Planning Prompt sections stored on the version.

PromptSection[]

Exact Main Guidelines sections stored on the version.

PromptSection[]

Exact Channel Prompt sections stored on the version.

curl --request GET \
  --url 'https://api-prod.usefini.com/v2/bots/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/hc-prompt/versions/9c59b2df-5d5f-4c9e-a070-9ac3c2b1b24e/public' \
  --header 'Authorization: Bearer fini_your_api_key'

Errors

401 Unauthorized

The API key is missing, malformed, revoked, or invalid.

403 Forbidden

The API key does not include read scope.

404 Not Found

The version does not exist for this agent.

406 Not Acceptable

The agent belongs to a different workspace.

⌘I

​Headers

​Path parameters

​Response

​Errors

Headers

Path parameters

Response

Errors