Circuit Operations API
Endpoints to operate on [Operations](/docs/models/operation) resources.
OpenAPI Specification
openapi: 3.1.0
info:
title: Spoke Depots Operations API
description: "This is the documentation of the Spoke Public API HTTP endpoints. The Spoke\nPublic API is a way for you to interact with Spoke products programmatically.\n\n# Introduction\n\nThe API has a set of HTTP methods to operate on Spoke resources for a specific\nteam.\n\nCurrently, Spoke offers no programming SDKs for interacting with the Public\nAPI, but you can implement your own interface by calling the methods documented\non this page.\n\n# Using the API\n\nThis section describes how the Spoke API should be used, if you wish to see\nexample implementations take a look at the [API Usage\nExamples](/docs/api-examples) page.\n\n## Address\n\nThe base API address for this version of the API to be used before every\nendpoint listed here is: `https://api.spoke.com/public/v0.2b`\n\nNotice the `https://` prefix, Spoke API will **not** accept plain HTTP\nrequests.\n\n## Authentication\n\nTo use Spoke Public API endpoints you will first need to generate an API key\nfor authenticating with our servers.\n\nTo do this you need to go to your Spoke Dispatch settings page > Integrations\n\\> API, and generate a new key there.\n\nOnce you have the API key you can use it in the `Authorization` header\neither using the Basic scheme, or as a Bearer token.\n\n### Basic Auth\n\n[Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) is the primary authentication scheme used\nby Spoke's API.\n\nBasic authentication typically uses a base64 encoded `username:password`\npair, but since we only require an API key we instead structure the payload as `[yourApiKey]:[empty]`. This\nvalue is then base64 encoded as usual.\n\nExample with `curl`:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/plans\" -u yourApiKey:\n```\n\nIf you did everything correctly you should see a list of your team's plans in response\nto this request.\n\nThe `-u` flag adds a header to the request in the following format:\n\n```http\nAuthorization: Basic eW91ckFwaUtleToK\n```\n\nNote that curl automatically base64 encoded the data. Other clients will do the same e.g. if using Postman you would\nconfigure the request's Authorization option instead of adding a header directly.\n\n### Bearer Token\n\nAlternatively you can pass the API key as a Bearer token without any special encoding.\ni.e. `Authorization: Bearer [yourApiKey]`.\n\nExample with `curl`:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/plans\" -H \"Authorization: Bearer yourApiKey\"\n```\n\n## On resource types\n\nEvery response from the Spoke Public API will be as JSON Objects, and every\nrequest that has a body also needs to be in that type, and the header\n`Content-type: application/json` needs to present, so the server knows that the\nbody you are sending is valid JSON. Spoke will reject requests without that\nheader, so be sure to use it.\n\n## On resource IDs\n\nEvery resource in the Spoke Public API has a unique ID. This ID is generated\nby Spoke and is unique for every resource per collection.\n\nEvery resource representation returned by the API will show the ID in the\nfollowing format:\n\n```json\n{\n \"id\": \"collectionName/resourceId\"\n}\n```\n\nAnd if the resource is on a sub-collection, it will be in the following format:\n\n```json\n{\n \"id\": \"collectionName/resourceId/subcollectionName/subResourceId\"\n}\n```\n\nFor example, a stop with ID `stop1` under a plan with ID `plan1` will have the\nfollowing representation on its serialized ID field:\n\n```json\n{\n \"id\": \"plans/plan1/stops/stop1\"\n}\n```\n\nThis means that if you wish to directly retrieve this stop by using a GET\nendpoint you can simply use this ID as follows:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/`serializedId`\" -u yourApiKey:\n```\n\nFor the example above this would be:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/plans/plan1/stops/stop1\" -u yourApiKey:\n```\n\n## On List endpoints\n\nWhen using list endpoints, you have the ability to combine various query options\nto locate the desired results. Some endpoints even offer specific filter options\nto aid in this search.\n\nAll the list endpoints employ pagination. This means that a single request might\nonly return a part of the entire set of resources you're aiming to retrieve. To\nmove through the subsequent pages, the Spoke API provides a `nextPageToken`\nfield in the response of every list endpoint query.\n\nIt's crucial to understand that when a `nextPageToken` is returned, it indicates\nthat more data is available. For every subsequent request, this token should be\nadded as the `pageToken` query parameter. And, importantly, **all the original\nquery parameters** used in the first request must also be included.\n\nHere's a step-by-step example to elucidate this:\n\n1. Suppose you initiate a request to list your plans:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/plans?filter.startsGte=2023-05-01\" -u yourApiKey:\n```\n\n2. The Spoke API might return a response like:\n\n```json\n{\n // other attributes\n \"nextPageToken\": \"I53Jr5Eu2qK9omh0iA8q\"\n}\n```\n\n3. To retrieve the next page of data, use the returned `nextPageToken` as the\n `pageToken` query parameter, and ensure all initial query parameters remain\n the same:\n\n```bash\ncurl \"https://api.spoke.com/public/v0.2b/plans?filter.startsGte=2023-05-01&pageToken=I53Jr5Eu2qK9omh0iA8q\" -u yourApiKey:\n```\n\n4. Repeat step 3 for all subsequent pages, updating the `pageToken` parameter\n with the latest `nextPageToken` value returned until `nextPageToken` is\n `null` in the response.\n\nSpoke also accepts limiting the maximum number of results per page by using\nthe `maxPageSize` query parameter, but notice that each individual endpoint has\na maximum value you can set this to.\n\n## On Update endpoints (HTTP PATCH verb)\n\nUpdate methods differ from the other methods in the API in the sense that\nmissing values in the JSON representation will **not** act upon the\nrepresentation of the resource.\n\nExplaining this by example: Suppose you have a Plan with the ID `plan1` in your\nplans' collection, and you wanted to merely update its title to `My API Plan`\nwithout changing other information, such as assigned drivers or the start date.\nTo do this you would issue the following request:\n\n```bash\ncurl -X PATCH http://localhost:5005/public/v0.2b/plans/plan1 -H 'Content-type: application/json' -d '{\"title\": \"My API Plan\"}' -u yourApiKey:\n```\n\nNotice how we don't pass any other information in the JSON, only the title. This\nensures that the `PATCH` request will only operate on the provided parameters\nand keep the other parameters as-is.\n\nIt is important to also notice that when updating an array the whole array will\nbe replaced, Spoke API does not support partial updates on arrays.\n\n## On Rate-Limiting\n\nAll the endpoints in the Spoke Public API are rate-limited, which means we\nwill reject requests that come in too fast.\n\nTo know if your request was rate-limited, check if the response has the HTTP\nstatus code 429.\n\nEach endpoint has a different rate limit, and Spoke can change this rate\nlimit at any moment.\n\nThe rate limits are as follows:\n\n- **Rate Limits for Write Endpoints**: All write endpoints have a limit of 5\n requests per second, which includes Creation (POST), Update (PATCH), and\n Deletion (DELETE) operations for all models.\n - An exception to this rule is the Driver Creation endpoint, which is limited to\n 1 request per second. Thus, we recommend using the Batch Import Drivers\n when adding multiple drivers.\n- **Rate Limits for Read Endpoints**: All read endpoints, including list\n endpoints, are limited to 10 requests per second.\n- **Rate Limits for Batch Import**:\n - The _Batch Import_ endpoints for Stops and Unassigned Stops models are\n limited to 100 requests per _10 minutes_ (with a maximum rate of 30 per _minute_).\n However, these endpoints can handle the import of up to 1,000 stops per minute.\n The Creation, Update, and Deletion endpoints for these models still maintain\n a rate limit of 5 requests per second.\n - The _Batch Import_ endpoint for Drivers is limited to 2 requests per\n _minute_. This allows for the import of up to 100 drivers per minute.\n- **Rate Limits for Optimization Endpoints**: The Plan _optimization_ and\n _re-optimization_ endpoints are limited to 100 requests per _10 minutes_\n (with a maximum rate of 30 per _minute_), due to the long running nature of these operations.\n\nSpoke API will occasionally support bursts of requests, but they cannot be\nsustained and will be rejected if they last too long.\n\nIf Spoke rejects your request because it exceeds the rate limit, you must\nwait before retrying it. We suggest you use an [exponential\nbackoff](https://en.wikipedia.org/wiki/Exponential_backoff) approach for this.\n\nWe also recommend, besides the exponential backoff algorithm, that you add a\nrandom delay to each attempt to prevent a [thundering herd\nproblem](https://en.wikipedia.org/wiki/Thundering_herd_problem).\n\nIf the client keeps retrying rate-limited requests while being rejected with a\n429 at a high rate, Spoke will keep rejecting the requests until you turn\ndown the request rate.\n\nSpoke will also limit requests if it keeps receiving them at a high frequency\nat or close to the requests limit for an extended period, so while we support\nan occasional burst of requests, if this is sustained for a long period, we\nwill rate-limit the client making them.\n\nWhile we feel these rate-limits will work for the vast majority of use cases we\nunderstand every team is different. So please reach out to us and describe your\nuse case if these limits are not enough for you, and we will evaluate\nincreasing them for your team.\n\n## On the models\n\nAfter this section you will find all the Spoke Public API endpoints available.\n\nEvery representation of resources that these endpoints create and return are\ndocumented in the [Models](/docs/category/models) page of the docs.\n"
version: v0.2b
servers:
- url: https://api.spoke.com/public/v0.2b
security:
- BasicAuth: []
tags:
- name: Operations
description: 'Endpoints to operate on [Operations](/docs/models/operation) resources.
'
paths:
/operations/{operationId}:cancel:
post:
operationId: cancelOperation
summary: Cancel an operation
tags:
- Operations
description: Cancel an operation that is not yet done.
parameters:
- schema:
type: string
pattern: ^[a-zA-Z0-9---_]{1,50}$
in: path
name: operationId
required: true
description: The ID of the operation to cancel.
responses:
'200':
description: The operation was canceled successfully
content:
application/json:
schema:
$ref: '#/components/schemas/operationSchema'
description: The operation was canceled successfully
'400':
description: ID format is invalid
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The error message.
code:
type: string
description: The error code.
param:
type: string
description: The parameter that caused the error.
url:
type: string
description: The URL with more information about the error.
required:
- message
description: ID format is invalid
title: The request is invalid
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The error message.
url:
type: string
description: The URL with more information about the error.
required:
- message
description: Unauthorized
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
message:
type: string
enum:
- The operation was not found.
code:
type: string
enum:
- operation_not_found
required:
- message
- code
description: Not Found
'409':
description: Client Error
content:
application/json:
schema:
type: object
properties:
message:
type: string
enum:
- The operation cannot be canceled because it is already done.
code:
type: string
enum:
- operation_already_done
required:
- message
- code
description: Client Error
'500':
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The error message.
code:
type: string
description: The error code.
param:
type: string
description: The parameter that caused the error.
url:
type: string
description: The URL with more information about the error.
required:
- message
description: An internal server error occurred
/operations/{operationId}:
get:
operationId: getOperation
summary: Retrieve an operation
tags:
- Operations
parameters:
- schema:
type: string
pattern: ^[a-zA-Z0-9---_]{1,50}$
in: path
name: operationId
required: true
description: The ID of the operation to cancel.
responses:
'200':
description: The requested operation
content:
application/json:
schema:
$ref: '#/components/schemas/operationSchema'
description: The requested operation
'400':
description: ID format is invalid
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The error message.
code:
type: string
description: The error code.
param:
type: string
description: The parameter that caused the error.
url:
type: string
description: The URL with more information about the error.
required:
- message
description: ID format is invalid
title: The request is invalid
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The error message.
url:
type: string
description: The URL with more information about the error.
required:
- message
description: Unauthorized
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
message:
type: string
enum:
- The operation was not found.
code:
type: string
enum:
- operation_not_found
required:
- message
- code
description: Not Found
'500':
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The error message.
code:
type: string
description: The error code.
param:
type: string
description: The parameter that caused the error.
url:
type: string
description: The URL with more information about the error.
required:
- message
description: An internal server error occurred
/operations:
get:
operationId: listOperations
summary: List operations
tags:
- Operations
parameters:
- schema:
type: string
minLength: 1
maxLength: 255
in: query
name: pageToken
required: false
description: The page token to continue from.
- schema:
default: 20
type: number
minimum: 1
maximum: 20
in: query
name: maxPageSize
required: false
description: The maximum number of operations to return per page.
- schema:
type: object
properties:
done:
description: Filter by whether the operation is done.
anyOf:
- type: string
enum:
- 'true'
- type: string
enum:
- 'false'
type:
description: The type of the operation. Use this to filter which operations to get when listing operations. If not specified, all operations are returned. If specified, only operations of the specified type are returned.
type: string
enum:
- plan_optimization
in: query
name: filter
required: false
description: The filter to apply to the list of operations.
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
operations:
type: array
items:
$ref: '#/components/schemas/operationSchema'
description: The operations.
nextPageToken:
anyOf:
- type: string
- type: 'null'
description: The next page token.
required:
- operations
- nextPageToken
definitions:
operationSchema:
type: object
properties:
id:
type: string
pattern: ^operations\/[a-zA-Z0-9---_]{1,50}$
description: The id of the operation, in the format `operations/<id>`.
type:
type: string
enum:
- plan_optimization
done:
type: boolean
description: Whether the operation is done.
metadata:
type: object
properties:
canceled:
type: boolean
description: Whether the operation was canceled.
startedAt:
type: number
description: The time the operation started at, in seconds since epoch.
finishedAt:
anyOf:
- type: number
- type: 'null'
description: The time the operation finished at, in seconds since epoch.
startedBy:
anyOf:
- type: string
enum:
- dispatcher
- type: string
enum:
- api
- type: string
description: The entity that started the operation.
targetPlanId:
type: string
pattern: ^plans\/[a-zA-Z0-9---_]{1,50}$
description: The id of the plan, in the format `plans/<id>`.
required:
- canceled
- startedAt
- finishedAt
- startedBy
- targetPlanId
description: Metadata related to a plan optimization operation.
result:
anyOf:
- anyOf:
- type: object
properties:
numOptimizedStops:
type: number
description: The number of stops that were considered for optimization.
skippedStops:
type: array
items:
type: object
properties:
id:
type: string
pattern: ^plans\/[a-zA-Z0-9---_]{1,50}\/stops\/[a-zA-Z0-9---_]{1,50}$
description: The id of the stop, in the format `plans/<id>/stops/<id>`.
reason:
anyOf:
- type: string
enum:
- impossible_time_window
- type: string
enum:
- impossible_navigation
- type: string
enum:
- impossible_number_of_stops
- type: string
enum:
- impossible_order_of_stops
- type: string
description: The reason the stop was skipped.
required:
- id
- reason
description: The stops that were skipped, if any.
required:
- numOptimizedStops
- skippedStops
- type: object
properties:
code:
type: string
description: A code that identifies the error
message:
type: string
description: A human-readable message that describes the error. This message is not intended to be parsed by machines.
required:
- code
- message
- type: 'null'
description: The result of the plan optimization operation, or an error.
required:
- id
- type
- done
- metadata
- result
description: Success
'400':
description: Query parameters are invalid
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The error message.
code:
type: string
description: The error code.
param:
type: string
description: The parameter that caused the error.
url:
type: string
description: The URL with more information about the error.
required:
- message
description: Query parameters are invalid
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The error message.
url:
type: string
description: The URL with more information about the error.
required:
- message
description: Unauthorized
'500':
description: An internal server error occurred
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The error message.
code:
type: string
description: The error code.
param:
type: string
description: The parameter that caused the error.
url:
type: string
description: The URL with more information about the error.
required:
- message
description: An internal server error occurred
components:
schemas:
operationIdSchema:
type: string
pattern: ^operations\/[a-zA-Z0-9---_]{1,50}$
planIdSchema:
type: string
pattern: ^plans\/[a-zA-Z0-9---_]{1,50}$
operationSchema:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/operationIdSchema'
description: The id of the operation, in the format `operations/<id>`.
type:
type: string
enum:
- plan_optimization
done:
type: boolean
description: Whether the operation is done.
metadata:
type: object
properties:
canceled:
type: boolean
description: Whether the operation was canceled.
startedAt:
type: number
description: The time the operation started at, in seconds since epoch.
finishedAt:
anyOf:
- type: number
- type: 'null'
description: The time the operation finished at, in seconds since epoch.
startedBy:
anyOf:
- type: string
enum:
- dispatcher
- type: string
enum:
- api
- type: string
description: The entity that started the operation.
targetPlanId:
allOf:
- $ref: '#/components/schemas/planIdSchema'
description: The id of the plan, in the format `plans/<id>`.
required:
- canceled
- startedAt
- finishedAt
- startedBy
- targetPlanId
description: Metadata related to a plan optimization operation.
result:
anyOf:
- anyOf:
- type: object
properties:
numOptimizedStops:
type: number
description: The number of stops that were considered for optimization.
skippedStops:
type: array
items:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/stopIdSchema'
description: The id of the stop, in the format `plans/<id>/stops/<id>`.
reason:
anyOf:
- type: string
enum:
- impossible_time_window
- type: string
enum:
- impossible_navigation
- type: string
enum:
- impossible_number_of_stops
- type: string
enum:
- impossible_order_of_stops
- type: string
description: The reason the stop was skipped.
required:
- id
- reason
description: The stops that were skipped, if any.
required:
- numOptimizedStops
- skippedStops
- type: object
properties:
code:
type: string
description: A code that identifies the error
message:
type: string
description: A human-readable message that describes the error. This message is not intended to be parsed by machines.
required:
- code
- message
- type: 'null'
description: The result of the plan optimization operation, or an error.
required:
- id
- type
- done
- metadata
- result
stopIdSchema:
type: string
pattern: ^plans\/[a-zA-Z0-9---_]{1,50}\/stops\/[a-zA-Z0-9---_]{1,50}$
securitySchemes:
BasicAuth:
type: http
scheme: basic
description: Use the API key as the username and leave the password empty.