Digital Humans

Generate Prompt Summary Endpoint

Changed on

Generate prompt summary for a prompt (only if prompt exceeds character limit).

post/v1/generate-prompt-summary

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/generate-prompt-summary
  • Auth
    HTTPBearer (a scheme the document does not define)

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Request body

prompt_idstring nullable

Deprecated. Use agent_version_id. Same uuid, still works.

agent_version_idstring nullable

Agent version UUID to summarize

Response

Successful Response

prompt_summarystring nullable

The generated prompt summary, or null if prompt is short

prompt_idstring required

Deprecated alias of agent_version_id

agent_version_idstring required

Agent version UUID that was summarized

skippedboolean

True if summary was skipped because prompt is short

Changes

  • 547d989af0efRevision changes
    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      request property deprecated

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      response property prompt_id deprecated

    • info

      added the required property to the response with the status

  • aa501502e1fcRevision changes
    • info

      added the new optional header request parameter X-Organization-Id