AskUI Schedules API
The schedules API from AskUI — 2 operation(s) for schedules.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/askui:askui-schedules-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: AskUI Workspaces Schedules API
version: 0.2.15
tags:
- name: Schedules
paths:
/api/v1/workspaces/{workspace_id}/schedules/{schedule_id}/suspend:
post:
tags:
- Schedules
summary: Suspend Schedule
operationId: suspend_schedule_api_v1_workspaces__workspace_id__schedules__schedule_id__suspend_post
security:
- Bearer: []
- Basic: []
parameters:
- name: schedule_id
in: path
required: true
schema:
type: string
title: Schedule Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid4
title: Workspace Id
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/workspaces/{workspace_id}/schedules:
post:
tags:
- Schedules
summary: Create Schedule
operationId: create_schedule_api_v1_workspaces__workspace_id__schedules_post
security:
- Bearer: []
- Basic: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid4
title: Workspace Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateScheduleRequestDto'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CreateScheduleResponseDto'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
RunnerHost:
type: string
enum:
- SELF
- ASKUI
title: RunnerHost
RunnerAssignment:
properties:
ids:
items:
type: string
type: array
title: Ids
host:
$ref: '#/components/schemas/RunnerHost'
tags:
items:
type: string
type: array
title: Tags
type: object
required:
- host
title: RunnerAssignment
CreateScheduleRequestDto:
properties:
name:
type: string
maxLength: 63
minLength: 1
title: Name
default: Unnamed
host:
$ref: '#/components/schemas/RunnerHost'
default: ASKUI
runner_ids:
items:
type: string
type: array
title: Runner Ids
tags:
items:
type: string
type: array
title: Tags
started_at:
type: string
format: date-time
title: Started At
description: Timestamp after which the schedule starts. If not specified, the schedule starts immediately.
ended_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Ended At
ended_after:
anyOf:
- type: integer
- type: 'null'
title: Ended After
description: Number of runs (more specifically, completions) after which the schedule ends, i.e., no more runs will be scheduled. If both ended_at and ended_after are specified, the schedule will end when either condition is met. If neither is specified, the schedule will run indefinitely.
schedule:
anyOf:
- type: string
- type: 'null'
title: Schedule
description: Cron expression specifying the schedule. If not specified, the schedule will run once on when started_at is reached which is now by default. end_at and ended_after will be ignored if schedule is not specified.
workflows:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Workflows
description: List of paths (not starting with '/' but relative to root of workspace) of workflows to be executed. Each string is a syntactically valid s3 object key or prefix. Cannot be empty. Strings starting with '.' will be ignored.
data:
additionalProperties: true
type: object
title: Data
description: Arbitrary data to be stored with the schedule which is made available to the runner when executing AskUI workflows.
type: object
title: CreateScheduleRequestDto
ScheduleStatus:
type: string
enum:
- ACTIVE
- SUSPENDED
- ENDED
title: ScheduleStatus
RunTemplate:
properties:
workspace_id:
type: string
title: Workspace Id
workflows:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Workflows
runner_assignment:
$ref: '#/components/schemas/RunnerAssignment'
data:
additionalProperties: true
type: object
title: Data
type: object
required:
- workspace_id
- runner_assignment
title: RunTemplate
CreateScheduleResponseDto:
properties:
id:
type: string
title: Id
created_at:
type: string
format: date-time
title: Created At
name:
type: string
title: Name
status:
$ref: '#/components/schemas/ScheduleStatus'
default: ACTIVE
started_at:
type: string
format: date-time
title: Started At
ended_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Ended At
schedule:
anyOf:
- type: string
- type: 'null'
title: Schedule
ended_after:
anyOf:
- type: integer
- type: 'null'
title: Ended After
run_template:
$ref: '#/components/schemas/RunTemplate'
runs_count:
type: integer
title: Runs Count
default: 0
type: object
required:
- name
- started_at
- run_template
title: CreateScheduleResponseDto
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
Bearer:
type: http
scheme: bearer
Basic:
type: apiKey
in: header
name: Authorization
x-provenance:
method: harvested
publisher: AskUI
source: https://workspaces.askui.com/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)