Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Julep Executions API

The Executions API from Julep — 5 operation(s) for executions.

Julep Executions API is one of 12 APIs that Julep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Executions. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 6 operations across 5 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://{serverEnv}.julep.ai/api.

6 operations 5 paths 11 schemas 4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.julep.ai/api
Authentication
API Key, API Key
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Julep Executions 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 6

Across 5 paths, the API surfaces 6 operations — 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Executions 6
POST
/executions
Resume an execution with a task token
ExecutionsRoute_resumeWithTaskToken 1 param body → 200
GET
/executions/{id}
Get an Execution by id
ExecutionsRoute_get 1 param → 200
PUT
/executions/{id}
Update an existing Execution
ExecutionsRoute_update 1 param body → 200
GET
/executions/{id}/status.stream
Stream the status of an execution
ExecutionStatusStreamRoute_stream 2 params → 200
GET
/executions/{id}/transitions
List the Transitions of an Execution by id
ExecutionTransitionsRoute_list 6 params → 200
GET
/executions/{id}/transitions.stream
Stream events emitted by the given execution
ExecutionTransitionsStreamRoute_stream 2 params → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Executions.Execution (10 properties), Executions.Transition (6 properties), Executions.TransitionEvent (4 properties), Executions.TransitionTarget (3 properties). Each schema is shown below with its type and property counts.

Executions.TaskTokenResumeExecutionRequest
object
2 properties 1 required
Executions.Execution
object
10 properties 6 required
Executions.Transition
object
6 properties 4 required
Common.uuid
string
Executions.TransitionTarget
object
3 properties 3 required
Executions.TransitionEvent
object
4 properties 4 required
Common.limit
integer
Limit the number of results
Executions.UpdateExecutionRequest
object
1 property 1 required
Common.stepLabel
string
A valid step label
Common.identifierSafeUnicode
string
For Unicode character safety See: https://unicode.org/reports/tr31/ See: https://www.unicode.org/reports/tr39/IdentifierCharacters
Common.offset
integer
Offset to apply to the results

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

julep-executions-api-openapi.yml Raw ↑

Other APIs Julep publishes across the network.

Julep Agents API
Julep Docs API
Julep Embed API
Julep Files API
Julep Jobs API
Julep Projects API
Julep Responses API
Julep Secrets API
Julep Sessions API
Julep Tasks API
Julep Users API