Prompts

Update a custom writing prompt

put/prompts/{id}

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/prompts/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Path parameters

idstring required

Prompt ID

Request body

$schemastring uri

A URL to the JSON Schema for this object.

categorystring required

Prompt category

examplestring required

Full example post for the prompt

textstring required

Prompt text

Example request

{
  "$schema": "https://example.com/api/v1/schemas/UpdatePromptInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

categorystring required

Prompt category

created_atstring required

Creation time (ISO 8601)

examplestring required

Full example post for the prompt (may be empty)

idstring required

Prompt ID

is_built_inboolean required

Whether this is a built-in prompt

textstring required

Prompt text

user_idstring

User ID (if custom)

workspace_idstring

Workspace ID (if custom)

Example response

{
  "$schema": "https://example.com/api/v1/schemas/PromptResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.