Genesys

Genesys Architect API

Flows, Prompts, IVR schedules, Dependency Tracking

GitHub OpenAPI

Operations 147

GET /api/v2/flows/datatables/divisionviews/{datatableId} Returns a specific datatable by id #
GET /api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId} Returns the state information about an export job #
POST /api/v2/flows/datatables/{datatableId}/export/jobs Begin an export process for exporting all rows from a datatable #
POST /api/v2/flows/datatables/{datatableId}/import/csv/jobs Begin an import process for importing rows from a CSV file into a datatable. #
GET /api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId} Returns the state information about an import job #
GET /api/v2/flows/datatables/{datatableId}/import/jobs Get all recent import jobs #
POST /api/v2/flows/datatables/{datatableId}/import/jobs Begin an import process for importing rows into a datatable. #
GET /api/v2/flows/datatables/{datatableId} Returns a specific datatable by id #
PUT /api/v2/flows/datatables/{datatableId} Updates a specific datatable by id #
DELETE /api/v2/flows/datatables/{datatableId} deletes a specific datatable by id #
GET /api/v2/flows/datatables/divisionviews Retrieve a list of datatables for the org #
GET /api/v2/flows/datatables Retrieve a list of datatables for the org #
POST /api/v2/flows/datatables Create a new datatable with the specified json-schema definition #
GET /api/v2/flows/datatables/{datatableId}/rows/{rowId} Returns a specific row for the datatable #
PUT /api/v2/flows/datatables/{datatableId}/rows/{rowId} Update a row entry #
DELETE /api/v2/flows/datatables/{datatableId}/rows/{rowId} Delete a row entry #
GET /api/v2/flows/datatables/{datatableId}/rows Returns the rows for the datatable with the given id #
POST /api/v2/flows/datatables/{datatableId}/rows Create a new row entry for the datatable #
GET /api/v2/flows/instances/{instanceId} Start a process (job) to prepare a download of a singular flow execution data… #
GET /api/v2/flows/instances/jobs/{jobId} Get the status and/or results of an asynchronous flow execution data retrieval… #
POST /api/v2/flows/instances/jobs Start a process (job) that will prepare a list of execution data IDs for… #
GET /api/v2/flows/instances/querycapabilities Retrieve a list of capabilities that the org can use to query for execution data #
POST /api/v2/flows/instances/query Query the database of existing flow histories to look for particular flow… #
GET /api/v2/flows/instances/settings/executiondata Get the execution history enabled setting #
PATCH /api/v2/flows/instances/settings/executiondata Edit the execution history enabled setting #
GET /api/v2/flows/instances/settings/loglevels/default Returns the flow default log level #
PUT /api/v2/flows/instances/settings/loglevels/default Edit the flow default log level #
DELETE /api/v2/flows/instances/settings/loglevels/default Resets the org log level to default, base #
GET /api/v2/flows/{flowId}/instances/settings/loglevels Retrieves the log level for a flow by flow id #
POST /api/v2/flows/{flowId}/instances/settings/loglevels Set the logLevel for a particular flow id #
PUT /api/v2/flows/{flowId}/instances/settings/loglevels Edit the logLevel for a particular flow id #
DELETE /api/v2/flows/{flowId}/instances/settings/loglevels Deletes a log level for a flow by flow id #
GET /api/v2/flows/instances/settings/loglevels/characteristics Gets the available flow log level characteristics for this organization #
GET /api/v2/flows/instances/settings/loglevels Retrieve a list of LogLevels for the organization #
POST /api/v2/flows/export/jobs Register Architect Export Job #
GET /api/v2/flows/export/jobs/{jobId} Fetch Architect Export Job Status #
POST /api/v2/flows/jobs Register Architect Job. #
GET /api/v2/flows/jobs/{jobId} Fetch Architect Job Status #
GET /api/v2/architect/dependencytracking/consumedresources Get resources that are consumed by a given Dependency Tracking object #
GET /api/v2/architect/dependencytracking/consumingresources Get resources that consume a given Dependency Tracking object #
GET /api/v2/architect/dependencytracking/deletedresourceconsumers Get Dependency Tracking objects that consume deleted resources #
GET /api/v2/architect/dependencytracking/build Get Dependency Tracking build status for an organization #
POST /api/v2/architect/dependencytracking/build Rebuild Dependency Tracking data for an organization #
GET /api/v2/architect/dependencytracking/object Get a Dependency Tracking object #
GET /api/v2/architect/dependencytracking Get Dependency Tracking objects that have a given display name #
GET /api/v2/architect/dependencytracking/types/{typeId} Get a Dependency Tracking type #
GET /api/v2/architect/dependencytracking/types Get Dependency Tracking types #
GET /api/v2/architect/emergencygroups/{emergencyGroupId} Gets a emergency group by ID #
PUT /api/v2/architect/emergencygroups/{emergencyGroupId} Updates a emergency group by ID #
DELETE /api/v2/architect/emergencygroups/{emergencyGroupId} Deletes a emergency group by ID #
GET /api/v2/architect/emergencygroups/divisionviews Get a pageable list of basic emergency group objects filterable by query… #
GET /api/v2/architect/emergencygroups Get a list of emergency groups #
POST /api/v2/architect/emergencygroups Creates a new emergency group #
POST /api/v2/flows/actions/unlock Unlock flow #
POST /api/v2/flows/actions/publish Publish flow #
POST /api/v2/flows/actions/revert Revert flow #
POST /api/v2/flows/actions/checkin Check-in flow #
POST /api/v2/flows/actions/checkout Check-out flow #
POST /api/v2/flows/actions/deactivate Deactivate flow #
GET /api/v2/flows/executions/{flowExecutionId} Get a flow execution's details. #
POST /api/v2/flows/executions Launch an instance of a flow definition, for flow types that support it such as… #
GET /api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health Get health scores and other health metrics for a specific intent. #
GET /api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health Get health metrics associated with a specific utterance of an intent #
GET /api/v2/flows/{flowId}/versions/{versionId}/health Get overall health scores for all intents present in the NLU domain version… #
GET /api/v2/flows/milestones/{milestoneId} Get a flow milestone #
PUT /api/v2/flows/milestones/{milestoneId} Updates a flow milestone #
DELETE /api/v2/flows/milestones/{milestoneId} Delete a flow milestone #
GET /api/v2/flows/milestones/divisionviews Get a pageable list of basic flow milestone information objects filterable by… #
GET /api/v2/flows/milestones Get a pageable list of flow milestones, filtered by query parameters #
POST /api/v2/flows/milestones Create a flow milestone #
GET /api/v2/flows/outcomes/{flowOutcomeId} Get a flow outcome #
PUT /api/v2/flows/outcomes/{flowOutcomeId} Updates a flow outcome #
GET /api/v2/flows/outcomes/divisionviews Get a pageable list of basic flow outcome information objects filterable by… #
GET /api/v2/flows/outcomes Get a pageable list of flow outcomes, filtered by query parameters #
POST /api/v2/flows/outcomes Create a flow outcome #
GET /api/v2/flows/{flowId} Get flow #
PUT /api/v2/flows/{flowId} Update flow #
DELETE /api/v2/flows/{flowId} Delete flow #
GET /api/v2/flows/{flowId}/latestconfiguration Get the latest configuration for flow #
POST /api/v2/flows/{flowId}/history Generate flow history #
GET /api/v2/flows/{flowId}/history/{historyId} Get generated flow history #
GET /api/v2/flows/{flowId}/versions/{versionId}/configuration Get flow version configuration #
GET /api/v2/flows/{flowId}/versions/{versionId} Get flow version #
GET /api/v2/flows/{flowId}/versions Get flow version list #
POST /api/v2/flows/{flowId}/versions Create flow version #
GET /api/v2/flows/divisionviews Get a pageable list of basic flow information objects filterable by query… #
GET /api/v2/flows/lookup Look up flows by ID #
GET /api/v2/flows Get a pageable list of flows, filtered by query parameters #
POST /api/v2/flows Create flow #
DELETE /api/v2/flows Batch-delete a list of flows #
GET /api/v2/architect/grammars/{grammarId}/languages/{languageCode} Get a grammar language #
DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode} Delete specified grammar language #
PATCH /api/v2/architect/grammars/{grammarId}/languages/{languageCode} Updates a grammar language #
POST /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice Creates a presigned URL for uploading a grammar voice mode file #
DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice Clear the voice mode file for the grammar language if there is one #
POST /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf Creates a presigned URL for uploading a grammar DTMF mode file #
DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf Clear the DTMF mode file for the grammar language if there is one #
POST /api/v2/architect/grammars/{grammarId}/languages Create a new language for a given grammar #
GET /api/v2/architect/grammars/{grammarId} Get a grammar #
DELETE /api/v2/architect/grammars/{grammarId} Delete a grammar #
PATCH /api/v2/architect/grammars/{grammarId} Updates a grammar #
GET /api/v2/architect/grammars Get a pageable list of grammars, filtered by query parameters #
POST /api/v2/architect/grammars Create a new grammar #
GET /api/v2/architect/ivrs/{ivrId}/identityresolution Get an IVR IdentityResolutionConfig #
PUT /api/v2/architect/ivrs/{ivrId}/identityresolution Update an IVR IdentityResolutionConfig #
GET /api/v2/architect/ivrs/{ivrId} Get an IVR config #
PUT /api/v2/architect/ivrs/{ivrId} Update an IVR Config #
DELETE /api/v2/architect/ivrs/{ivrId} Delete an IVR Config #
GET /api/v2/architect/ivrs Get IVR configs #
POST /api/v2/architect/ivrs Create IVR config #
GET /api/v2/architect/ivrs/divisionviews Get a pageable list of basic ivr configuration information objects filterable… #
GET /api/v2/architect/prompts/{promptId}/resources/{languageCode} Get specified user prompt resource #
PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode} Update specified user prompt resource #
DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode} Delete specified user prompt resource #
DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio Delete specified user prompt resource audio #
GET /api/v2/architect/prompts/{promptId}/resources Get a pageable list of user prompt resources #
POST /api/v2/architect/prompts/{promptId}/resources Create a new user prompt resource #
POST /api/v2/architect/prompts/{promptId}/history Generate prompt history #
GET /api/v2/architect/prompts/{promptId} Get specified user prompt #
PUT /api/v2/architect/prompts/{promptId} Update specified user prompt #
DELETE /api/v2/architect/prompts/{promptId} Delete specified user prompt #
GET /api/v2/architect/prompts/{promptId}/history/{historyId} Get generated prompt history #
GET /api/v2/architect/prompts Get a pageable list of user prompts #
POST /api/v2/architect/prompts Create a new user prompt #
DELETE /api/v2/architect/prompts Batch-delete a list of prompts #
GET /api/v2/architect/schedulegroups/{scheduleGroupId} Gets a schedule group by ID #
PUT /api/v2/architect/schedulegroups/{scheduleGroupId} Updates a schedule group by ID #
DELETE /api/v2/architect/schedulegroups/{scheduleGroupId} Deletes a schedule group by ID #
GET /api/v2/architect/schedulegroups/divisionviews Get a pageable list of basic schedule group configuration information objects… #
GET /api/v2/architect/schedulegroups Get a list of schedule groups #
POST /api/v2/architect/schedulegroups Creates a new schedule group #
GET /api/v2/architect/schedules/{scheduleId} Get a schedule by ID #
PUT /api/v2/architect/schedules/{scheduleId} Update schedule by ID #
DELETE /api/v2/architect/schedules/{scheduleId} Delete a schedule by id #
GET /api/v2/architect/schedules/divisionviews Get a pageable list of basic schedule configuration information objects… #
GET /api/v2/architect/schedules Get a list of schedules #
POST /api/v2/architect/schedules Create a new schedule #
GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} Get a system prompt resource #
PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} Updates a system prompt resource override #
DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} Delete a system prompt resource override #
GET /api/v2/architect/systemprompts/{promptId}/resources Get system prompt resources #
POST /api/v2/architect/systemprompts/{promptId}/resources Create system prompt resource override #
POST /api/v2/architect/systemprompts/{promptId}/history Generate system prompt history #
GET /api/v2/architect/systemprompts/{promptId}/history/{historyId} Get generated prompt history #
GET /api/v2/architect/systemprompts/{promptId} Get a system prompt #
GET /api/v2/architect/systemprompts Get System Prompts #
GET /api/v2/architect/dependencytracking/updatedresourceconsumers Get Dependency Tracking objects that depend on updated resources #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-architect-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys:genesys-architect-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

genesys-architect-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Architect API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:


# --- truncated at 32 KB (1366 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-architect-api-openapi.yml