Skip to main content
API docs by Redocly

Parallel Works API (4.x.x)

Authentication

OIDC login callback

This endpoint is called by the OIDC provider after the user has authenticated. It exchanges the authorization code for an access token and then uses the access token to get the user info.

Authorizations:
ApiKeyAuth
query Parameters
object

Responses

Response samples

Content type
application/json
null

Redirect to OIDC auth

Redirects the user to the OIDC authorization endpoint

Authorizations:
ApiKeyAuth
path Parameters
authID
required
string

Responses

Get OIDC token

Get an OIDC token for the logged in user

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
"string"

Get Workflow OIDC token

Get an OIDC token for the logged in user for a specific workflow run

Authorizations:
ApiKeyAuth
query Parameters
object

Responses

Response samples

Content type
application/json
"string"

Identify self

Returns the currently authenticated subject

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
"string"

Identify organization

Returns the currently authenticated subject's organization

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
"string"

OIDC configuration

Returns the openid configuration

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "claims_supported": [
    ],
  • "id_token_signing_alg_values_supported": [
    ],
  • "issuer": "string",
  • "jwks_uri": "string",
  • "subject_types_supported": [
    ]
}

List keys

Returns the list of public keys used for verifying JWTs

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "keys": [
    ]
}

Organization

Create OIDC auth method

Create an OIDC auth method for an organization

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
Request Body schema: application/json
required
authorizationEndpoint
string
clientId
string
clientSecret
string
discoverEndpoints
boolean
issuer
string
name
string
scopes
string
tokenEndpoint
string
userinfoEndpoint
string

Responses

Request samples

Content type
application/json
{
  • "authorizationEndpoint": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "discoverEndpoints": true,
  • "issuer": "string",
  • "name": "string",
  • "scopes": "string",
  • "tokenEndpoint": "string",
  • "userinfoEndpoint": "string"
}

Response samples

Content type
application/json
{
  • "AuthMethod": { }
}

AI Chat

Remove bucket from AI Chat

Remove a bucket from an AI Chat using the bucket id

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
namespace
required
string
aiName
required
string
bucketId
required
string

Responses

Reindex attached bucket

Reindex attached buckets to refresh the data AI Chat can reference

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
namespace
required
string
aiName
required
string
bucketId
required
string

Responses

Attach bucket to AI Chat

Attach a bucket using the bucket id to an AI Chat

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
namespace
required
string
aiName
required
string
bucketId
required
string
Request Body schema: application/json
required
refreshInterval
string

Responses

Request samples

Content type
application/json
{
  • "refreshInterval": "string"
}

Delete AI Chat

Delete AI Chat resource by name

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
namespace
required
string
aiName
required
string

Responses

Get AI Chat

Get AI Chat resource by name

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
namespace
required
string
aiName
required
string

Responses

Response samples

Content type
application/json
{
  • "csp": "string",
  • "currentlyProvisioning": true,
  • "expiresAt": { },
  • "ingested": true,
  • "name": "string",
  • "namespace": "string",
  • "provisionOutput": null,
  • "provisioned": true,
  • "variables": null
}

Reindex attached buckets

Reindex attached buckets to refresh the data AI Chat can reference

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
namespace
required
string
aiName
required
string

Responses

List AI Chat

List AI Chat resources

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "ai": [
    ]
}

Create AI Chat

Create AI Chat resource

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
namespace
required
string
Request Body schema: application/json
required
baseInfraId
string
csp
string
description
string
name
string
tags
string
team
string
variables
github.com/parallelworks/core/packages/go/ingress/api/organizations/_orgName_/namespaces/_namespace_/aichat.Variables

Responses

Request samples

Content type
application/json
{
  • "baseInfraId": "string",
  • "csp": "string",
  • "description": "string",
  • "name": "string",
  • "tags": "string",
  • "team": "string",
  • "variables": null
}

Cluster

Update provision status

Update the provision status of a cluster session

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
namespace
required
string
clusterName
required
string
sessionNumber
required
string
Request Body schema: application/json
required
provisionStatus
object

Responses

Request samples

Content type
application/json
{
  • "provisionStatus": { }
}

Provision Status

Get provision status

Get the provision status of an infrastructure by infraId

Authorizations:
ApiKeyAuth
path Parameters
orgName
required
string
infraId
required
string

Responses

Response samples

Content type
application/json
[ ]

Cluster Images

Delete image

Delete image by name

Authorizations:
ApiKeyAuth
path Parameters
name
required
string

Responses

Get images

Get images

Authorizations:
ApiKeyAuth
query Parameters
object

Responses

Response samples

Content type
application/json
[ ]

Create image

Create image

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
architecture
string
csp
string
cspId
string
name
string
published
boolean
region
string
type
string

Responses

Request samples

Content type
application/json
{
  • "architecture": "string",
  • "csp": "string",
  • "cspId": "string",
  • "name": "string",
  • "published": true,
  • "region": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "architecture": "string",
  • "created_at": { },
  • "createdAt": { },
  • "csp": "string",
  • "cspId": "string",
  • "id": { },
  • "latest": true,
  • "name": "string",
  • "organization,omitempty": "string",
  • "published": true,
  • "region": "string",
  • "type": "string",
  • "updatedAt": { }
}

Admin

Get platform license

Get the platform license

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "expiration": "string",
  • "license": "string"
}

Update platform license

Update the platform license

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
license
string

Responses

Request samples

Content type
application/json
{
  • "license": "string"
}

Sessions

Update session access

Update session access by name and namespace, allowing access to specific groups

Authorizations:
ApiKeyAuth
path Parameters
namespace
required
string
name
required
string
Request Body schema: application/json
required
access
boolean
teamId
string

Responses

Request samples

Content type
application/json
{
  • "access": true,
  • "teamId": "string"
}

Delete session

Delete the session with the provided name in the provided namespace

Authorizations:
ApiKeyAuth
path Parameters
namespace
required
string
name
required
string

Responses

Get session

Returns a given session by name and namespace

Authorizations:
ApiKeyAuth
path Parameters
namespace
required
string
name
required
string

Responses

Response samples

Content type
application/json
null

Update session

Update the session with the provided name in the provided namespace

Authorizations:
ApiKeyAuth
path Parameters
namespace
required
string
name
required
string
Request Body schema: application/json
required
localPort
integer
name
string
remoteHost
string
remotePort
integer
slug
string
status
string
targetId
string

Responses

Request samples

Content type
application/json
{
  • "localPort": 0,
  • "name": "string",
  • "remoteHost": "string",
  • "remotePort": 0,
  • "slug": "string",
  • "status": "string",
  • "targetId": "string"
}

Response samples

Content type
application/json
null

Get sessions

Returns all the sessions for the authenticated user

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
[ ]