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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Genesys

Genesys Architect API

Flows, Prompts, IVR schedules, Dependency Tracking

Documentation Provider Profile APIs.io OpenAPI GitHub

Genesys Architect API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Architect. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 147 operations across 93 paths, and defines 182 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

147 operations 93 paths 182 schemas 20 DELETE73 GET3 PATCH36 POST15 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys Architect API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 147

Across 93 paths, the API surfaces 147 operations — 20 DELETE, 73 GET, 3 PATCH, 36 POST, 15 PUT. Each is listed below with its method, path, parameters, and response codes.

Architect 147

Flows, Prompts, IVR schedules, Dependency Tracking

GET
/api/v2/flows/datatables/divisionviews/{datatableId}
Returns a specific datatable by id
getFlowsDatatablesDivisionview 2 params → 200400401403404408409413
GET
/api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId}
Returns the state information about an export job
getFlowsDatatableExportJob 2 params → 200202400401403404408409
POST
/api/v2/flows/datatables/{datatableId}/export/jobs
Begin an export process for exporting all rows from a datatable
postFlowsDatatableExportJobs 1 param → 200202400401403404408409
POST
/api/v2/flows/datatables/{datatableId}/import/csv/jobs
Begin an import process for importing rows from a CSV file into a datatable. CSV file is uploaded by performing a PUT request against the URL in the returned 'uploadURI' field. Headers for the PUT re…
postFlowsDatatableImportCsvJobs 2 params → 200202400401403404408409
GET
/api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId}
Returns the state information about an import job
getFlowsDatatableImportJob 2 params → 200202400401403404408409
GET
/api/v2/flows/datatables/{datatableId}/import/jobs
Get all recent import jobs
getFlowsDatatableImportJobs 3 params → 200400401403404408409413
POST
/api/v2/flows/datatables/{datatableId}/import/jobsdeprecated
Begin an import process for importing rows into a datatable. Apps should migrate to use POST /api/v2/flows/datatables/{datatableId}/import/csv/jobs instead
postFlowsDatatableImportJobs 2 params → 200202400401403404408409
GET
/api/v2/flows/datatables/{datatableId}
Returns a specific datatable by id
getFlowsDatatable 2 params → 200400401403404408409413
PUT
/api/v2/flows/datatables/{datatableId}
Updates a specific datatable by id
putFlowsDatatable 3 params → 200400401403404408409413
DELETE
/api/v2/flows/datatables/{datatableId}
deletes a specific datatable by id
deleteFlowsDatatable 2 params → 204400401403404408409413
GET
/api/v2/flows/datatables/divisionviews
Retrieve a list of datatables for the org
getFlowsDatatablesDivisionviews 7 params → 200400401403404408409413
GET
/api/v2/flows/datatables
Retrieve a list of datatables for the org
getFlowsDatatables 7 params → 200400401403404408409413
POST
/api/v2/flows/datatables
Create a new datatable with the specified json-schema definition
postFlowsDatatables 1 param → 200400401403404408409413
GET
/api/v2/flows/datatables/{datatableId}/rows/{rowId}
Returns a specific row for the datatable
getFlowsDatatableRow 3 params → 200400401403404408409413
PUT
/api/v2/flows/datatables/{datatableId}/rows/{rowId}
Update a row entry
putFlowsDatatableRow 3 params → 200400401403404408409413
DELETE
/api/v2/flows/datatables/{datatableId}/rows/{rowId}
Delete a row entry
deleteFlowsDatatableRow 2 params → 204400401403404408409413
GET
/api/v2/flows/datatables/{datatableId}/rows
Returns the rows for the datatable with the given id
getFlowsDatatableRows 5 params → 200400401403404408409413
POST
/api/v2/flows/datatables/{datatableId}/rows
Create a new row entry for the datatable.
postFlowsDatatableRows 2 params → 200400401403404408409413
GET
/api/v2/flows/instances/{instanceId}
Start a process (job) to prepare a download of a singular flow execution data instance by Id
getFlowsInstance 2 params → 200400401403404408409413
GET
/api/v2/flows/instances/jobs/{jobId}
Get the status and/or results of an asynchronous flow execution data retrieval job
getFlowsInstancesJob 1 param → 200202400401403404408409
POST
/api/v2/flows/instances/jobs
Start a process (job) that will prepare a list of execution data IDs for download.
postFlowsInstancesJobs 2 params → 200400401403404408409413
GET
/api/v2/flows/instances/querycapabilities
Retrieve a list of capabilities that the org can use to query for execution data
getFlowsInstancesQuerycapabilities 1 param → 200400401403404408409413
POST
/api/v2/flows/instances/query
Query the database of existing flow histories to look for particular flow criteria
postFlowsInstancesQuery 3 params → 200400401403404408409413
GET
/api/v2/flows/instances/settings/executiondata
Get the execution history enabled setting.
getFlowsInstancesSettingsExecutiondata → 200400401403404408409413
PATCH
/api/v2/flows/instances/settings/executiondata
Edit the execution history enabled setting.
patchFlowsInstancesSettingsExecutiondata 1 param → 200400401403404408409413
GET
/api/v2/flows/instances/settings/loglevels/default
Returns the flow default log level.
getFlowsInstancesSettingsLoglevelsDefault 1 param → 200400401403404408409413
PUT
/api/v2/flows/instances/settings/loglevels/default
Edit the flow default log level.
putFlowsInstancesSettingsLoglevelsDefault 2 params → 200400401403404408409413
DELETE
/api/v2/flows/instances/settings/loglevels/default
Resets the org log level to default, base
deleteFlowsInstancesSettingsLoglevelsDefault → 204400401403404408409413
GET
/api/v2/flows/{flowId}/instances/settings/loglevels
Retrieves the log level for a flow by flow id.
getFlowInstancesSettingsLoglevels 2 params → 200400401403404408409413
POST
/api/v2/flows/{flowId}/instances/settings/loglevels
Set the logLevel for a particular flow id
postFlowInstancesSettingsLoglevels 3 params → 200400401403404408409413
PUT
/api/v2/flows/{flowId}/instances/settings/loglevels
Edit the logLevel for a particular flow id
putFlowInstancesSettingsLoglevels 3 params → 200400401403404408409413
DELETE
/api/v2/flows/{flowId}/instances/settings/loglevels
Deletes a log level for a flow by flow id.
deleteFlowInstancesSettingsLoglevels 1 param → 204400401403404408409413
GET
/api/v2/flows/instances/settings/loglevels/characteristics
Gets the available flow log level characteristics for this organization.
getFlowsInstancesSettingsLoglevelsCharacteristics → 200400401403404408409413
GET
/api/v2/flows/instances/settings/loglevels
Retrieve a list of LogLevels for the organization.
getFlowsInstancesSettingsLoglevels 3 params → 200400401403404408409413
POST
/api/v2/flows/export/jobs
Register Architect Export Job
postFlowsExportJobs 1 param → 200202400401403404408409
GET
/api/v2/flows/export/jobs/{jobId}
Fetch Architect Export Job Status
getFlowsExportJob 2 params → 200400401403404408409413
POST
/api/v2/flows/jobs
Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.
postFlowsJobs 1 param → 200202400401403404408409
GET
/api/v2/flows/jobs/{jobId}
Fetch Architect Job Status
getFlowsJob 2 params → 200400401403404408409413
GET
/api/v2/architect/dependencytracking/consumedresources
Get resources that are consumed by a given Dependency Tracking object
getArchitectDependencytrackingConsumedresources 6 params → 200206400401403404408409
GET
/api/v2/architect/dependencytracking/consumingresources
Get resources that consume a given Dependency Tracking object
getArchitectDependencytrackingConsumingresources 7 params → 200206400401403404408409
GET
/api/v2/architect/dependencytracking/deletedresourceconsumers
Get Dependency Tracking objects that consume deleted resources
getArchitectDependencytrackingDeletedresourceconsumers 7 params → 200206400401403404408409
GET
/api/v2/architect/dependencytracking/build
Get Dependency Tracking build status for an organization
getArchitectDependencytrackingBuild → 200400401403404408409413
POST
/api/v2/architect/dependencytracking/build
Rebuild Dependency Tracking data for an organization
postArchitectDependencytrackingBuild → 202400401403404408409413
GET
/api/v2/architect/dependencytracking/object
Get a Dependency Tracking object
getArchitectDependencytrackingObject 8 params → 200206400401403404408409
GET
/api/v2/architect/dependencytracking
Get Dependency Tracking objects that have a given display name
getArchitectDependencytracking 8 params → 200206400401403404408409
GET
/api/v2/architect/dependencytracking/types/{typeId}
Get a Dependency Tracking type.
getArchitectDependencytrackingType 1 param → 200400401403404408409413
GET
/api/v2/architect/dependencytracking/types
Get Dependency Tracking types.
getArchitectDependencytrackingTypes 2 params → 200400401403404408409413
GET
/api/v2/architect/emergencygroups/{emergencyGroupId}
Gets a emergency group by ID
getArchitectEmergencygroup 1 param → 200400401403404408409413
PUT
/api/v2/architect/emergencygroups/{emergencyGroupId}
Updates a emergency group by ID
putArchitectEmergencygroup 2 params → 200400401403404408409413
DELETE
/api/v2/architect/emergencygroups/{emergencyGroupId}
Deletes a emergency group by ID
deleteArchitectEmergencygroup 1 param → 200400401403404408409413
GET
/api/v2/architect/emergencygroups/divisionviews
Get a pageable list of basic emergency group objects filterable by query parameters.
getArchitectEmergencygroupsDivisionviews 7 params → 200400401403404408409413
GET
/api/v2/architect/emergencygroups
Get a list of emergency groups.
getArchitectEmergencygroups 5 params → 200400401403404408409413
POST
/api/v2/architect/emergencygroups
Creates a new emergency group
postArchitectEmergencygroups 1 param → 200400401403404408409413
POST
/api/v2/flows/actions/unlock
Unlock flow
postFlowsActionsUnlock 1 param → 200400401403404408409413
POST
/api/v2/flows/actions/publish
Publish flow
postFlowsActionsPublish 2 params → 200202400401403404408409
POST
/api/v2/flows/actions/revert
Revert flow
postFlowsActionsRevert 1 param → 200400401403404408409413
POST
/api/v2/flows/actions/checkin
Check-in flow
postFlowsActionsCheckin 1 param → 200400401403404408409413
POST
/api/v2/flows/actions/checkout
Check-out flow
postFlowsActionsCheckout 1 param → 200400401403404408409413
POST
/api/v2/flows/actions/deactivate
Deactivate flow
postFlowsActionsDeactivate 1 param → 200400401403404408409413
GET
/api/v2/flows/executions/{flowExecutionId}
Get a flow execution's details. Flow execution details are available for several days after the flow is started.
getFlowsExecution 1 param → 200400401403404408409413
POST
/api/v2/flows/executions
Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
postFlowsExecutions 1 param → 200400401403404408409413
GET
/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health
Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.
getFlowVersionIntentHealth 4 params → 200400401403404408409413
GET
/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health
Get health metrics associated with a specific utterance of an intent.
getFlowVersionIntentUtteranceHealth 5 params → 200400401403404408409413
GET
/api/v2/flows/{flowId}/versions/{versionId}/health
Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
getFlowVersionHealth 3 params → 200400401403404408409413
GET
/api/v2/flows/milestones/{milestoneId}
Get a flow milestone
getFlowsMilestone 1 param → 200400401403404408409413
PUT
/api/v2/flows/milestones/{milestoneId}
Updates a flow milestone
putFlowsMilestone 2 params → 200400401403404408409413
DELETE
/api/v2/flows/milestones/{milestoneId}
Delete a flow milestone.
deleteFlowsMilestone 1 param → 200204400401403404408409
GET
/api/v2/flows/milestones/divisionviews
Get a pageable list of basic flow milestone information objects filterable by query parameters.
getFlowsMilestonesDivisionviews 7 params → 200400401403404408409413
GET
/api/v2/flows/milestones
Get a pageable list of flow milestones, filtered by query parameters
getFlowsMilestones 9 params → 200400401403404408409413
POST
/api/v2/flows/milestones
Create a flow milestone
postFlowsMilestones 1 param → 200400401403404408409413
GET
/api/v2/flows/outcomes/{flowOutcomeId}
Get a flow outcome
getFlowsOutcome 1 param → 200400401403404408409413
PUT
/api/v2/flows/outcomes/{flowOutcomeId}
Updates a flow outcome
putFlowsOutcome 2 params → 200400401403404408409413
GET
/api/v2/flows/outcomes/divisionviews
Get a pageable list of basic flow outcome information objects filterable by query parameters.
getFlowsOutcomesDivisionviews 7 params → 200400401403404408409413
GET
/api/v2/flows/outcomes
Get a pageable list of flow outcomes, filtered by query parameters
getFlowsOutcomes 9 params → 200400401403404408409413
POST
/api/v2/flows/outcomes
Create a flow outcome
postFlowsOutcomes 1 param → 200400401403404408409413
GET
/api/v2/flows/{flowId}
Get flow
getFlow 2 params → 200400401403404408409413
PUT
/api/v2/flows/{flowId}
Update flow
putFlow 2 params → 200400401403404408409413
DELETE
/api/v2/flows/{flowId}
Delete flow
deleteFlow 1 param → default400401403404408409413
GET
/api/v2/flows/{flowId}/latestconfiguration
Get the latest configuration for flow
getFlowLatestconfiguration 2 params → 200400401403404408409413
POST
/api/v2/flows/{flowId}/history
Generate flow history
postFlowHistory 1 param → 200400401403404408409413
GET
/api/v2/flows/{flowId}/history/{historyId}
Get generated flow history
getFlowHistoryHistoryId 7 params → 200400401403404408409413
GET
/api/v2/flows/{flowId}/versions/{versionId}/configuration
Get flow version configuration
getFlowVersionConfiguration 3 params → 200400401403404408409413
GET
/api/v2/flows/{flowId}/versions/{versionId}
Get flow version
getFlowVersion 3 params → 200400401403404408409413
GET
/api/v2/flows/{flowId}/versions
Get flow version list
getFlowVersions 4 params → 200400401403404408409413
POST
/api/v2/flows/{flowId}/versions
Create flow version
postFlowVersions 2 params → 200400401403404408409413
GET
/api/v2/flows/divisionviews
Get a pageable list of basic flow information objects filterable by query parameters.
getFlowsDivisionviews 12 params → 200400401403404408409413
GET
/api/v2/flows/lookup
Look up flows by ID
getFlowsLookup 5 params → 200400401403404408409413
GET
/api/v2/flows
Get a pageable list of flows, filtered by query parameters
getFlows 20 params → 200400401403404408409413
POST
/api/v2/flows
Create flow
postFlows 2 params → 200400401403404408409413
DELETE
/api/v2/flows
Batch-delete a list of flows
deleteFlows 1 param → 200400401403404408409413
GET
/api/v2/architect/grammars/{grammarId}/languages/{languageCode}
Get a grammar language.
getArchitectGrammarLanguage 2 params → 200400401403404408409413
DELETE
/api/v2/architect/grammars/{grammarId}/languages/{languageCode}
Delete specified grammar language
deleteArchitectGrammarLanguage 2 params → 204400401403404408409413
PATCH
/api/v2/architect/grammars/{grammarId}/languages/{languageCode}
Updates a grammar language
patchArchitectGrammarLanguage 3 params → 200400401403404408409413
POST
/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice
Creates a presigned URL for uploading a grammar voice mode file
postArchitectGrammarLanguageFilesVoice 3 params → 200400401403404408409413
DELETE
/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice
Clear the voice mode file for the grammar language if there is one
deleteArchitectGrammarLanguageFilesVoice 2 params → 204400401403404408409413
POST
/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf
Creates a presigned URL for uploading a grammar DTMF mode file
postArchitectGrammarLanguageFilesDtmf 3 params → 200400401403404408409413
DELETE
/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf
Clear the DTMF mode file for the grammar language if there is one
deleteArchitectGrammarLanguageFilesDtmf 2 params → 204400401403404408409413
POST
/api/v2/architect/grammars/{grammarId}/languages
Create a new language for a given grammar
postArchitectGrammarLanguages 2 params → 200400401403404408409413
GET
/api/v2/architect/grammars/{grammarId}
Get a grammar
getArchitectGrammar 2 params → 200400401403404408409413
DELETE
/api/v2/architect/grammars/{grammarId}
Delete a grammar.
deleteArchitectGrammar 1 param → 200204400401403404408409
PATCH
/api/v2/architect/grammars/{grammarId}
Updates a grammar
patchArchitectGrammar 2 params → 200400401403404408409413
GET
/api/v2/architect/grammars
Get a pageable list of grammars, filtered by query parameters
getArchitectGrammars 9 params → 200400401403404408409413
POST
/api/v2/architect/grammars
Create a new grammar
postArchitectGrammars 1 param → 200400401403404408409413
GET
/api/v2/architect/ivrs/{ivrId}/identityresolution
Get an IVR IdentityResolutionConfig.
getArchitectIvrIdentityresolution 1 param → 200400401403404408409413
PUT
/api/v2/architect/ivrs/{ivrId}/identityresolution
Update an IVR IdentityResolutionConfig.
putArchitectIvrIdentityresolution 2 params → 200400401403404408409413
GET
/api/v2/architect/ivrs/{ivrId}
Get an IVR config.
getArchitectIvr 1 param → 200400401403404408409413
PUT
/api/v2/architect/ivrs/{ivrId}
Update an IVR Config.
putArchitectIvr 2 params → 200400401403404408409413
DELETE
/api/v2/architect/ivrs/{ivrId}
Delete an IVR Config.
deleteArchitectIvr 1 param → 200400401403404408409413
GET
/api/v2/architect/ivrs
Get IVR configs.
getArchitectIvrs 8 params → 200400401403404408409413
POST
/api/v2/architect/ivrs
Create IVR config.
postArchitectIvrs 1 param → 200400401403404408409413
GET
/api/v2/architect/ivrs/divisionviews
Get a pageable list of basic ivr configuration information objects filterable by query parameters.
getArchitectIvrsDivisionviews 7 params → 200400401403404408409413
GET
/api/v2/architect/prompts/{promptId}/resources/{languageCode}
Get specified user prompt resource
getArchitectPromptResource 2 params → 200400401403404408409413
PUT
/api/v2/architect/prompts/{promptId}/resources/{languageCode}
Update specified user prompt resource
putArchitectPromptResource 3 params → 200400401403404408409413
DELETE
/api/v2/architect/prompts/{promptId}/resources/{languageCode}
Delete specified user prompt resource
deleteArchitectPromptResource 2 params → default400401403404408409413
DELETE
/api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio
Delete specified user prompt resource audio
deleteArchitectPromptResourceAudio 2 params → 204400401403404408409413
GET
/api/v2/architect/prompts/{promptId}/resources
Get a pageable list of user prompt resources
getArchitectPromptResources 3 params → 200400401403404408409413
POST
/api/v2/architect/prompts/{promptId}/resources
Create a new user prompt resource
postArchitectPromptResources 2 params → 200400401403404408409413
POST
/api/v2/architect/prompts/{promptId}/history
Generate prompt history
postArchitectPromptHistory 1 param → 200400401403404408409413
GET
/api/v2/architect/prompts/{promptId}
Get specified user prompt
getArchitectPrompt 4 params → 200206400401403404408409
PUT
/api/v2/architect/prompts/{promptId}
Update specified user prompt
putArchitectPrompt 2 params → 200400401403404408409413
DELETE
/api/v2/architect/prompts/{promptId}
Delete specified user prompt
deleteArchitectPrompt 2 params → default400401403404408409413
GET
/api/v2/architect/prompts/{promptId}/history/{historyId}
Get generated prompt history
getArchitectPromptHistoryHistoryId 7 params → 200400401403404408409413
GET
/api/v2/architect/prompts
Get a pageable list of user prompts
getArchitectPrompts 10 params → 200206400401403404408409
POST
/api/v2/architect/prompts
Create a new user prompt
postArchitectPrompts 1 param → 200400401403404408409413
DELETE
/api/v2/architect/prompts
Batch-delete a list of prompts
deleteArchitectPrompts 1 param → 200400401403404408409413
GET
/api/v2/architect/schedulegroups/{scheduleGroupId}
Gets a schedule group by ID
getArchitectSchedulegroup 1 param → 200400401403404408409413
PUT
/api/v2/architect/schedulegroups/{scheduleGroupId}
Updates a schedule group by ID
putArchitectSchedulegroup 2 params → 200400401403404408409413
DELETE
/api/v2/architect/schedulegroups/{scheduleGroupId}
Deletes a schedule group by ID
deleteArchitectSchedulegroup 1 param → 200400401403404408409413
GET
/api/v2/architect/schedulegroups/divisionviews
Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
getArchitectSchedulegroupsDivisionviews 7 params → 200400401403404408409413
GET
/api/v2/architect/schedulegroups
Get a list of schedule groups.
getArchitectSchedulegroups 7 params → 200400401403404408409413
POST
/api/v2/architect/schedulegroups
Creates a new schedule group
postArchitectSchedulegroups 1 param → 200400401403404408409413
GET
/api/v2/architect/schedules/{scheduleId}
Get a schedule by ID
getArchitectSchedule 1 param → 200400401403404408409413
PUT
/api/v2/architect/schedules/{scheduleId}
Update schedule by ID
putArchitectSchedule 2 params → 200400401403404408409413
DELETE
/api/v2/architect/schedules/{scheduleId}
Delete a schedule by id
deleteArchitectSchedule 1 param → 200400401403404408409413
GET
/api/v2/architect/schedules/divisionviews
Get a pageable list of basic schedule configuration information objects filterable by query parameters.
getArchitectSchedulesDivisionviews 7 params → 200400401403404408409413
GET
/api/v2/architect/schedules
Get a list of schedules.
getArchitectSchedules 6 params → 200400401403404408409413
POST
/api/v2/architect/schedules
Create a new schedule.
postArchitectSchedules 1 param → 200400401403404408409413
GET
/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
Get a system prompt resource.
getArchitectSystempromptResource 2 params → 200400401403404408409413
PUT
/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
Updates a system prompt resource override.
putArchitectSystempromptResource 3 params → 200400401403404408409413
DELETE
/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
Delete a system prompt resource override.
deleteArchitectSystempromptResource 2 params → 200400401403404408409413
GET
/api/v2/architect/systemprompts/{promptId}/resources
Get system prompt resources.
getArchitectSystempromptResources 5 params → 200400401403404408409413
POST
/api/v2/architect/systemprompts/{promptId}/resources
Create system prompt resource override.
postArchitectSystempromptResources 2 params → 200400401403404408409413
POST
/api/v2/architect/systemprompts/{promptId}/history
Generate system prompt history
postArchitectSystempromptHistory 1 param → 200400401403404408409413
GET
/api/v2/architect/systemprompts/{promptId}/history/{historyId}
Get generated prompt history
getArchitectSystempromptHistoryHistoryId 7 params → 200400401403404408409413
GET
/api/v2/architect/systemprompts/{promptId}
Get a system prompt
getArchitectSystemprompt 4 params → 200206400401403404408409
GET
/api/v2/architect/systemprompts
Get System Prompts
getArchitectSystemprompts 10 params → 200206400401403404408409
GET
/api/v2/architect/dependencytracking/updatedresourceconsumers
Get Dependency Tracking objects that depend on updated resources
getArchitectDependencytrackingUpdatedresourceconsumers 6 params → 200206400401403404408409

Schemas 182

The contract defines 182 schemas that model the data the API accepts and returns. The most detailed are User (39 properties), Flow (24 properties), FlowVersion (24 properties), HistoryListing (20 properties). Each schema is shown below with its type and property counts.

Team
object
8 properties 1 required
NluInfo
object
5 properties
NluDomain
object
9 properties 1 required
WorkPlanBidRanks
object
4 properties
AddressableEntityRef
object
2 properties
NluDomainVersion
object
16 properties 1 required
JsonSchemaDocument
object
A JSON Schema document.
8 properties
AudioFormat
object
4 properties
FlowOutcomeDivisionView
object
4 properties 1 required
ResourcePermissionPolicy
object
11 properties
ScheduleGroupDivisionView
object
A schedule group.
4 properties 1 required
WritableDivision
object
3 properties
ExportDetails
object
3 properties 1 required
DataTable
object
Contains a metadata representation for a JSON schema stored in DataTables along with an optional field for the schema itself
6 properties
FlowMilestoneDivisionView
object
4 properties 1 required
SystemPromptAsset
object
15 properties 1 required
FlowHealthIntent
object
6 properties
LocaleFlowVersionInfo
object
1 property
UserStations
object
4 properties
AdditionalLanguagesSynonyms
object
1 property
LocaleInfo
object
3 properties
FlowExecutionDataQueryResult
object
This is the metadata of an executionData entry for a flow.
13 properties
OAuthLastTokenIssued
object
1 property
PromptEntityListing
object
10 properties
FlowLogLevelCharacteristicsDefinitions
object
A set of available characteristic definitions
2 properties
RegisterArchitectExportJob
object
1 property 1 required
MediaSummary
object
2 properties
LocationAddressVerificationDetails
object
4 properties
DependencyStatus
object
10 properties
NluUtterance
object
3 properties 1 required
Geolocation
object
11 properties
DataTableRowEntityListing
object
10 properties
ConfusionIntentInfo
object
3 properties
DependencyType
object
4 properties
FlowMilestone
object
5 properties 1 required
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
FlowHealthIntentInfo
object
4 properties
GrammarLanguage
object
8 properties
FlowCharacteristics
object
This is a set of enabled characteristics for the loglevel
8 properties
FlowHealthUtterance
object
8 properties
ConfusionUtterance
object
3 properties
FlowDivisionViewEntityListing
object
10 properties
UploadUrlResponse
object
3 properties
RegisterArchitectJobRequest
object
User
object
39 properties 1 required
MediaSummaryDetail
object
2 properties
NamedEntityTypeItem
object
3 properties 1 required
Grammar
object
5 properties
ArchitectFlowReference
object
4 properties
Biography
object
5 properties
GrammarFileUploadRequest
object
1 property
FlowRuntimeExecution
object
Details about the current state of a Flow execution
11 properties 3 required
ScheduleEntityListing
object
11 properties
LocaleHealth
object
3 properties
CriteriaItem
object
A singular criteria used to query executionData.
3 properties
DependencyTypeEntityListing
object
10 properties
FlowResultEntityListing
object
10 properties
ResourceConditionNode
object
5 properties
FlowLogLevelRequest
object
Used to set the log level of a particular flow
1 property 1 required
GrammarLanguageFileMetadata
object
4 properties
IVRIdentityResolutionConfig
object
3 properties 1 required
NamedEntityDefinition
object
2 properties 2 required
RegisterArchitectJobResponse
object
4 properties
OutlierInfo
object
2 properties
FlowLogLevelCharacteristicsDefinition
object
Defines a characteristic that can be captured by data providers
3 properties
DomainEntityRef
object
3 properties
Empty
object
ArchitectExportJobStateResponse
object
6 properties
EmergencyCallFlow
object
An emergency flow associates a call flow to use in an emergency with the ivr(s) to route to it.
2 properties
EmergencyGroupDivisionViewEntityListing
object
11 properties
Prompt
object
6 properties 1 required
IVRDivisionViewEntityListing
object
11 properties
FlowSettingsResponseEntityListing
object
10 properties
DomainRole
object
2 properties
FlowHealthErrorInfo
object
4 properties
QueryCriteria
object
A criteria type that can be used in tandem with other criteria type to create queries of executionData
6 properties
EmergencyGroupListing
object
10 properties
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
FlowHealth
object
4 properties
FlowHealthIntentVersionInfo
object
3 properties
ConfusionIntentDetails
object
5 properties
PresenceDefinition
object
3 properties
HistoryEntry
object
9 properties
Detail
object
4 properties
SystemPromptEntityListing
object
10 properties
FlowHealthVersionInfo
object
2 properties
GetFlowExecutionDataJobResult
object
This is a list of executionData links that can be used to download the complete executionData
5 properties
ConfusionInfo
object
1 property
UserAuthorization
object
4 properties
NamedEntityTypeMechanismExample
object
2 properties 2 required
OutOfOffice
object
8 properties
PromptAssetCreate
object
14 properties 1 required
IVR
object
Defines the phone numbers, operating hours, and the Architect flows to execute for an IVR.
18 properties 1 required
UserPresence
object
10 properties
LocationEmergencyNumber
object
3 properties
ExecutionDataSettingsRequest
object
1 property 1 required
NamedEntityTypeDefinition
object
3 properties 2 required
ArchitectJobMessage
object
3 properties
FailedObject
object
4 properties
EmployerInfo
object
4 properties
CriteriaGroup
object
A group of logical or a singular criteria used to create a query of executionData
4 properties
EmergencyGroup
object
A group of emergency call flows to use in an emergency.
15 properties 1 required
ConsumingResourcesEntityListing
object
10 properties
RoutingStatus
object
3 properties
DataTableImportEntityListing
object
5 properties
ResourceConditionValue
object
2 properties
NamedEntityTypeMechanism
object
8 properties 2 required
Operation
object
10 properties
ConfusionDetails
object
1 property
Limit
object
3 properties
ScheduleGroup
object
A group of schedules that define the operating hours of an organization.
17 properties 1 required
Schedule
object
Defines a period of time to perform a specific action. Each schedule must be associated with one or more schedule groups to be used.
16 properties 3 required
IntentReference
object
2 properties 1 required
EmergencyGroupDivisionView
object
A group of call flows.
4 properties 1 required
SystemPrompt
object
5 properties
FlowHealthIntentUtterance
object
6 properties
DataTableImportJob
object
State information for an import job of rows to a datatable
14 properties 1 required
Dependency
object
8 properties
Chat
object
1 property
FlowOutcomeListing
object
10 properties
GroupContact
object
5 properties 3 required
Contact
object
7 properties
LocationDefinition
object
16 properties
FlowLogLevel
object
This is a table of settings per a loglevel that define what will be logged in executionData when enabled (true)
2 properties
FlowsQueryCriteriaResponse
object
The response for QueryCapabilities which contains the allowed criteria, flow types and action types for the organization.
5 properties
NamedEntityTypeBinding
object
2 properties 2 required
UserConversationSummary
object
8 properties
GrammarListing
object
10 properties
Image
object
2 properties
ExecutionDataFlowSettingsResponse
object
7 properties
Education
object
5 properties
IVRDivisionView
object
An ivr.
4 properties 1 required
DataTablesDomainEntityListing
object
10 properties
UserReference
object
2 properties
FlowEntityListing
object
10 properties
CriteriaQuery
object
Used to retrieve executionData based upon certain criteria
1 property 1 required
FlowVersionEntityListing
object
10 properties
ConsumedResourcesEntityListing
object
10 properties
DependencyObjectEntityListing
object
10 properties
FlowVersion
object
24 properties
PromptAssetEntityListing
object
10 properties
NluUtteranceSegment
object
2 properties 1 required
ErrorBody
object
11 properties
LocationImage
object
2 properties
Division
object
3 properties
FlowExecutionLaunchRequest
object
Parameters for launching a flow.
4 properties 1 required
ExecutionDataEntity
object
Represents an individual result of an execution data lookup
4 properties
CriteriaCategoryInfo
object
2 properties
ScheduleGroupEntityListing
object
11 properties
WritableStarrableDivision
object
3 properties
FlowDivisionView
object
11 properties 1 required
UserStation
object
8 properties
NamedEntityAnnotation
object
1 property 1 required
FlowSettingsResponse
object
This is a table of settings per a loglevel that define what will be logged in executionData when enabled (true)
8 properties
FlowOutcome
object
6 properties 1 required
DataTableExportJob
object
State information for an export job of rows from a datatable
10 properties 1 required
Group
object
17 properties 4 required
ExecutionDataRequest
object
Used to retrieve a set of executionData history by the respective ids
1 property 1 required
HistoryListing
object
20 properties
Location
object
5 properties
IVREntityListing
object
11 properties
HealthInfo
object
6 properties
SchedulesDivisionView
object
A schedule.
4 properties 1 required
Intent
object
2 properties
ScheduleGroupDivisionViewEntityListing
object
11 properties
FlowExecutionLaunchResponse
object
Response object from launching a flow.
4 properties
SystemPromptAssetEntityListing
object
10 properties
Flow
object
24 properties 1 required
SupportedLanguage
object
2 properties
FlowMilestoneListing
object
10 properties
NluDomainVersionReference
object
4 properties
GrammarLanguageUpdate
object
2 properties
AdditionalLanguagesIntent
object
2 properties
PromptAsset
object
14 properties
FlowOutcomeDivisionViewEntityListing
object
10 properties
DependencyObject
object
10 properties
ArchitectJobStateResponse
object
6 properties
FlowMilestoneDivisionViewEntityListing
object
10 properties
RegisterArchitectExportJobResponse
object
4 properties
IntentDefinition
object
7 properties 2 required
LocationAddress
object
7 properties
ScheduleDivisionViewEntityListing
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-architect-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
AE Profile APIs.io
Genesys Agent Copilot API
AE Profile APIs.io
Genesys Agent UI API
AE Profile APIs.io
Genesys AI Studio API
AE Profile APIs.io
Genesys Alerting API
AE Profile APIs.io
Genesys Analytics API
AE Profile APIs.io
Genesys Assistant Copilot Variations API
AE Profile APIs.io
Genesys Audit API
AE Profile APIs.io
Genesys Authorization API
AE Profile APIs.io
Genesys Background Assistant API
AE Profile APIs.io
Genesys Billing API
AE Profile APIs.io
Genesys Business Rules API
AE Profile APIs.io
#Architect
← Back to G APIs
API Details
ID
genesys:genesys-architect-api
Base URL
https://api.mypurecloud.com
Docs
https://developer.genesys.cloud/platform/api/
Provider
Genesys
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=genesys-architect-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-architect-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Genesys Architect 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.