Get a response format preset
https://api.respan.ai/api/response-format-presets/{id}/Retrieve the complete saved response-format schema text.
Servers
https://api.respan.ai: Respan API Server
Authentication
RespanApiKey
Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.
HTTP scheme: bearer; format: Respan API key.
Authorization: Bearer $RESPAN_API_KEYOr:
DashboardJwt
Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.
HTTP scheme: bearer; format: Dashboard JWT.
Authorization: Bearer $RESPAN_DASHBOARD_JWTPath parameters
id string RequiredResponses
200
Response-format preset.
application/json
$ object Body
id string Required in parentname string Required in parentcreated_by object or null Optional
created_by.id integer or string Optional
created_by.id (oneOf 1) integer Schema variantcreated_by.id (oneOf 2) string Schema variantcreated_by.email string Optionalemailcreated_by.name string Optionalcreated_by.username string Optionalcreated_by.first_name string Optionalcreated_by.last_name string Optionalcreated_at string Required in parentdate-timeupdated_at string Required in parentdate-timeresponse_format_content string Required in parentname and an object-valued schema.is_enforcing_response_format boolean Required in parentOpenAPI response schema
{
"type": "object",
"required": [
"id",
"name",
"response_format_content",
"is_enforcing_response_format",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"created_by": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"email": {
"type": "string",
"format": "email"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"response_format_content": {
"type": "string",
"description": "JSON text preserved verbatim. It must decode to an object with a non-empty `name` and an object-valued `schema`."
},
"is_enforcing_response_format": {
"type": "boolean"
}
}
}403
The API key is missing, invalid or expired.
application/json
$ object Body
detail string Required in parentOpenAPI response schema
{
"type": "object",
"required": [
"detail"
],
"properties": {
"detail": {
"type": "string"
}
}
}Example
{
"detail": "Your API key is invalid or expired, please check your API key in the platform settings."
}404
Preset not found in the caller’s project.
application/json
$ object BodyOpenAPI response schema
{
"type": "object",
"additionalProperties": true
}OpenAPI source
The operation and referenced components below retain the complete OpenAPI definitions, including constraints and examples.
OpenAPI operation
{
"summary": "Get a response format preset",
"operationId": "api_response_format_presets_retrieve",
"tags": [
"Prompts"
],
"description": "Retrieve the complete saved response-format schema text.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Response-format preset ID."
}
],
"responses": {
"200": {
"description": "Response-format preset.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"id",
"name",
"response_format_content",
"is_enforcing_response_format",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"created_by": {
"type": "object",
"nullable": true,
"properties": {
"id": {
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
},
"email": {
"type": "string",
"format": "email"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"response_format_content": {
"type": "string",
"description": "JSON text preserved verbatim. It must decode to an object with a non-empty `name` and an object-valued `schema`."
},
"is_enforcing_response_format": {
"type": "boolean"
}
}
}
}
}
},
"403": {
"$ref": "#/components/responses/InvalidApiKey"
},
"404": {
"description": "Preset not found in the caller's project.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"security": [
{
"RespanApiKey": []
},
{
"DashboardJwt": []
}
]
}OpenAPI path metadata
{}Referenced OpenAPI components
{
"responses": {
"InvalidApiKey": {
"description": "The API key is missing, invalid or expired.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"detail"
],
"properties": {
"detail": {
"type": "string"
}
}
},
"example": {
"detail": "Your API key is invalid or expired, please check your API key in the platform settings."
}
}
}
}
},
"securitySchemes": {
"DashboardJwt": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "Dashboard JWT",
"description": "Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.",
"x-fern-bearer": {
"name": "dashboardJwt",
"env": "RESPAN_DASHBOARD_JWT"
}
},
"RespanApiKey": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "Respan API key",
"description": "Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.",
"x-fern-bearer": {
"name": "respanApiKey",
"env": "RESPAN_API_KEY"
}
}
}
}