Description of API Access¶

The Production Copilot is accessible via API.

First, you need a technical user with the required roles and scopes. You can acquire this in the settings application.

• Create a technical user
• Copy/store the user credentials

• Assign at least the following role:

  • mdsp:core:pcass.r to have basic read access in the API — this supports the common functions in the chat.

• Furthermore, you might need specific roles according to the used skills. For example if you need access to Insights Hub Asset Management, you should also assign the related role for this service.
  In the description of pre-built skills the minimum required roles for each skill are listed.

• Get the bearer token.
• With the token, you can now query the API.

Request URL:
http://gateway.eu1.mindsphere.io/api/assistant/v3/openai/assistant/completion?configId=7c599a7d-53c3-4699-886d-c3a93ff16bda

Request Method:
POST

Request Body
{
  "messages": [
    {
      "role": "user",
      "content": "What can you do for me?"
    }
  ]
}

Restrictions:

With the technical user, you can currently query agents which are using:

• the RAG database when the skill findInDocuments is used.
• the prebuilt agents and skills – in this case, related roles need to be added to the technical user.
• skills using public endpoints in Visual Flow Creator.

Custom skills using Visual Flow Creator are currently not supported. You will get an authentication issue in the chat when these kinds of skills are queried.

Bruno Collection¶

You can try the following Bruno collection to get started:
Bruno Collection

• Import the collection into Bruno.
• Adapt the parameters in the environment configuration according to your tenant.
  
• Send the request to get the token.
• Send the request to get the response.
  

Usage in VFC¶

Visual Flow Creator can also query the Production Copilot API.

• You can use the request node and activate the Insights Hub service checkbox, which handles the authentication.
  

Use the ready-to-use example flow and import it into your Visual Flow Creator:
Visual Flow Creator and Copilot API example flow

Together with the inject node where you can configure regular intervals or schedules, you can create agentic flows, which are triggered on your demand.