How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Optilogic Workspace API

Get information about a workspace, including job and file information

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

Tagged areas include Workspace. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 21 operations across 18 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.optilogic.app/v0.

21 operations 18 paths 34 schemas 2 DELETE10 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.optilogic.app/v0
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Optilogic Workspace API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (APIKeyHeader).

Paths & Operations 21

Across 18 paths, the API surfaces 21 operations — 2 DELETE, 10 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

workspace 21

Get information about a workspace, including job and file information

GET
/workspaces
Get a list of available workspaces in an account
→ 200401
GET
/{workspace}
Get information about a workspace
1 param → 200400401403404
GET
/{workspace}/jobs
List the jobs for a specific workspace
7 params → 200401403404
GET
/{workspace}/jobs/stats
Get the stats only for jobs for a specific workspace
7 params → 200401403404
POST
/{workspace}/job
Queue a job
8 params → 200400401403
GET
/{workspace}/job/{jobKey}
Get job information
3 params → 200400401403404
DELETE
/{workspace}/job/{jobKey}
Stop a queued or running job
2 params → 200400401403404
POST
/{workspace}/jobBatch/jobify
Queue a list of jobs
3 params body → 200400401403
POST
/{workspace}/jobBatch/jobify/searchNRun
Queue a list of jobs from a list of search terms
3 params body → 200400401403
POST
/{workspace}/jobBatch/backToBack
Run a list of python modules
5 params body → 200400401403
POST
/{workspace}/jobBatch/backToBack/searchNRun
Run a list of matching python modules.
5 params body → 200400401403
GET
/{workspace}/files
List all user files in the workspace
5 params → 200401403404
GET
/{workspace}/job/{jobKey}/ledger
Get records from the specified job's ledger
4 params → 200400401403404
GET
/{workspace}/job/{jobKey}/metrics
Get metrics gathered while the job was running
2 params → 200400401403404
GET
/{workspace}/job/{jobKey}/metrics/stats
Get a roll-up of metric statistics gathered while the job was running
2 params → 200400401403404
POST
/{workspace}/file/copy
Copy a file within a workspace
6 params → 202400401404403412
POST
/{workspace}/file/share
Share a file with other users
4 params → 202400401404403
GET
/{workspace}/file/{directoryPath}/{filename}
Get a file from a specific workspace
4 params → 200400401403404
POST
/{workspace}/file/{directoryPath}/{filename}
Upload a file to a workspace
6 params → 201400401403412
DELETE
/{workspace}/file/{directoryPath}/{filename}
Delete a specific file from a workspace
3 params → 202400401403404
POST
/{workspace}/folder/share
Share a folder with other users
4 params → 202400401404403

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are File (11 properties), JobStatusCounts (10 properties), Job (9 properties), FileShare (8 properties). Each schema is shown below with its type and property counts.

JobMetricsStats
object
3 properties
FileList
object
4 properties 3 required
JobDetailsInfo
object
6 properties
JobLedger
object
3 properties
JobifyPost
object
5 properties
FileDelete
object
2 properties
JobDetailsResourceConfig
object
4 properties
FolderShare
object
8 properties
FileMicroInfo
object
2 properties
FileShortInfoPath
object
4 properties
Error
object
3 properties
FileShare
object
8 properties
JobListStats
object
5 properties
ErrorFileShare
object
5 properties
WorkspaceList
object
3 properties
JobTagCounts
object
1 property
ErrorFolderShare
object
6 properties
JobPost
object
4 properties
ErrorFileCopy
object
6 properties
File
object
11 properties
JobList
object
6 properties
JobMetrics
object
4 properties
Job
object
9 properties
JobInfo
object
8 properties
Forbidden
object
4 properties
JobDelete
object
5 properties
JobListFilters
object
6 properties
FileShortInfo
object
3 properties
CopyFile
object
5 properties
UploadFile
object
2 properties
Workspace
object
5 properties
BatchPost
object
5 properties
JobStatusCounts
object
10 properties
WorkspaceInfo
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optilogic-workspace-api-openapi.yml Raw ↑

Other APIs Optilogic publishes across the network.

Optilogic MCP Server (Ada Connector)
Optilogic Authentication API
Optilogic Job API
Optilogic Storage API
Optilogic storage : custom columns API
Optilogic storage : custom tables API
Optilogic storage : labels API
Optilogic storage : sharing API
Optilogic storage : tags API
Optilogic storage : templates API
Optilogic Utility API
Where this information came from

This is an independent, third-party profile of Optilogic Workspace API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.