U-xer APIs

📚 Knowledge Base
1

If you want to call U-xer functions outside of the U-xer, you may want to use U-xer APIs to achieve that. You can use APIs to integrate U-xer with your other tools.

How to use:

  1. First, get a token using the Login API.
  2. Then use that token to call other APIs.

Complete APIs List and API playground
https://gateway.u-xer.com/swagger/index.html

Most useful APIs are listed below:

Login:
Use your email and password to get a token. Then use this token to call other APIs.

POST https://gateway.u-xer.com/api/Auth/login
{
  "email": "string",
  "password": "string"
}

Job Run:

GET https://gateway.u-xer.com/api/Job/{id}/run
GET https://gateway.u-xer.com/api/Job/{id}/run/requestid/{requestid}
GET https://gateway.u-xer.com/api/Job/{id}/run/agent/{agentid}
GET https://gateway.u-xer.com/api/Job/{id}/run/requestid/{requestid}/agent/{agentid}

Scenario Run:

GET https://gateway.u-xer.com/api/Scenario/{id}/run
GET https://gateway.u-xer.com/api/Scenario/{id}/run/agent/{agentid}
GET https://gateway.u-xer.com/api/Scenario/{id}/run/requestid/{requestid}
GET https://gateway.u-xer.com/api/Scenario/{id}/run/requestid/{requestid}/agent/{agentid}

Get Result of the execution using request id
POST https://gateway.u-xer.com/api/Execution/search

Here is the API tutorial explaining how you can run a scenario with 3rd party tools

https://video.uxer.ai/page/team-communication_4ab3c265?custom_asset_token=W5BGAtWPqIylulkzESvQVXExsSIa6qTL_WCCP9XXfY0&hvlk=OYMPzbdjjPnx&org_tok=VcYk54byH8TGOyOAuN6gkw&hv_id=C6Cl9PzLLQykTleKl2nFL3SEdTVz4AUEssxBz2RUbBE&utm_source=extension_share_privately&hvre=false

Watch Video

2 Likes
2

Just want to share my trick to get answer about APIs.

Download the Uxer API JSON file
https://gateway.u-xer.com/swagger/v1/swagger.json

Upload to your fav AI service and “chat with document” in this case, the JSON file.

Screenshot_2024-07-06-12-52-56-671_com.android.chrome-edit
Screenshot_2024-07-06-12-52-56-671_com.android.chrome-edit1080×851 148 KB

2 Likes
3

This is a super smart approach :slight_smile:

Thanks for sharing @bukit

4

Thanks @Zekeriya,

If you have the time, maybe create a chatgpt custom gpt by uploading the U-xer openapi json.

Great for branding and useful for the users as well.

5

This Makes sense, It should be possible easily ! :slight_smile:

1 Like
6

Hi @Zekeriya ,
Thanks for a great tool!

I wonder is it possible to pass values for the parameters when I run a scenario through the api?

OR, can I call the parameter endpoint to update the parameter value of an existing parameter used in the scenario before running it?

The use case is I have a scenario and I want to run it through the api with different values for the parameters.

Thanks for your help!
Elisha

7

Hi @kleine2 ,

Thanks for the question.

Yes, You can use parameter API’s to update the parameter.

8

Update suggestions, since AI getting smarter, make a uxer official skill, cli or mcp for actual commands and apis.

resources:

9

Hi Bukit,

We are currently working on a different way of automation. It will take sometime but I know it is gonna be amazing!

Lots of thing will change, it may not satisfy everyone but the end result will be much helpful in many ways.

Really appreciated your effort to make this product better!

3 Likes
10

I’d like to see uxer like text based version of n8n/make/zapier (easy integration and data manipulation), current add-ons as the node with direct integration inside scenario editor (convert as addon when highlighting N lines of the steps so it become reusable, just browse addons like we browse commands available).