Julep Responses API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (ApiKeyAuth).
An API key is passed in the header as X-Auth-Key (ApiKeyAuth_).
By default, every request must be authenticated.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Responses 2
POST
/responses
Creates a model response. Provide text or image inputs to generate text or JSON outputs.
ResponsesRoute_createResponsebody→ 200
GET
/responses/{id}
Get a response by id
ResponsesRoute_getResponse2 params→ 200
Schemas 64
The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are Responses.Response (23 properties), Responses.CreateResponse (23 properties), Responses.ComputerToolCallOutput (6 properties), Responses.ComputerToolCall (6 properties). Each schema is shown below with its type and property counts.
Responses.ReasoningEffort
string
Constraint effort on reasoning models.
Responses.ComputerTool
object
4 properties4 required
Responses.ReasoningItem
object
4 properties3 required
Responses.FilePath
object
3 properties3 required
Responses.InputImage
object
4 properties2 required
Responses.FunctionToolCallOutput
object
5 properties3 required
Responses.ResponseStatus
string
Responses.ToolChoiceFunction
object
Use this option to force the model to call a specific function.
2 properties2 required
Responses.FunctionTool
object
5 properties3 required
Responses.WebSearchToolCall
object
3 properties3 required
Responses.Screenshot
object
1 property1 required
Responses.BaseTool
object
1 property1 required
Responses.MessageStatus
string
Responses.UrlCitation
object
5 properties5 required
Responses.ResponseFormatJsonObject
object
JSON object response format. An older method of generating JSON responses. Using jsonschema is recommended for models that support it. Note that the model will…
1 property1 required
Responses.InputItem
Responses.ItemReference
Content item used to generate a response.
Responses.Wait
object
1 property1 required
Responses.Type
object
2 properties2 required
Responses.Scroll
object
5 properties5 required
Responses.FunctionToolCall
object
6 properties5 required
Responses.OutputMessage
object
5 properties5 required
Responses.OutputText
object
3 properties3 required
Responses.ResponseError
object
4 properties2 required
Responses.FunctionToolCallOutputResource
object
1 property
Responses.Refusal
object
2 properties2 required
Responses.Includable
string
Responses.ResponseFormatText
object
Default response format. Used to generate text responses.
1 property1 required
Responses.MessageRole
string
Responses.InputFile
object
A file input to the model.
4 properties1 required
InputMessageContentList
array
Responses.ComputerToolCallOutputResource
object
1 property1 required
Responses.CreateResponse
object
23 properties2 required
Responses.TextResponseFormatJsonSchema
object
JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](/docs/guides/structured-outputs).
5 properties2 required
Responses.Item
object
An item representing part of the context for the response to be generated by the model. Can contain text, images, and audio inputs, as well as previous assista…
1 property1 required
Responses.ComputerToolCallSafetyCheck
object
3 properties3 required
Responses.FileSearchToolCall
object
5 properties4 required
Responses.ComputerScreenshotImage
object
3 properties1 required
Responses.InputMessageResource
object
1 property1 required
Responses.FileCitation
object
3 properties3 required
Responses.ComputerToolCall
object
6 properties6 required
Responses.VectorStoreFileAttributesString
string
Responses.OutputItem
Responses.ToolChoiceTypes
object
Indicates that the model should use a built-in tool to generate a response. [Learn more about built-in tools](/docs/guides/tools).
1 property1 required
Responses.Coordinate
object
2 properties2 required
Responses.ToolChoiceOptions
string
Responses.EasyInputMessage
object
3 properties3 required
Responses.Move
object
3 properties3 required
Responses.DoubleClick
object
3 properties3 required
Responses.InputMessage
object
4 properties4 required
Responses.Drag
object
2 properties2 required
Responses.Tool
Responses.VectorStoreFileAttributes
object
Set of key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and qu…
1 property1 required
Responses.Click
object
4 properties4 required
Responses.KeyPress
object
2 properties2 required
Responses.Reasoning
object
Reasoning configuration options for o-series models.
2 properties1 required
Responses.ComputerToolCallOutput
object
6 properties3 required
Responses.Response
object
23 properties14 required
Responses.WebSearchStatus
string
Responses.ReasoningContent
object
2 properties2 required
Responses.InputText
object
2 properties2 required
Responses.ResponseUsage
object
5 properties5 required
Responses.FileSearchTool
object
5 properties2 required
Responses.WebSearchTool
object
4 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
