Skip to content
API Reference
/
ai-mentor
/
ai_mentor_orgs_users_planned_jobs_retrieve

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai_mentor_orgs_users_planned_jobs_list

Request

Endpoints for viewing jobs and their status A job run refers to a task with steps that an agent is going to undertake. You can filter job runs by their status. Note that for a single user and a specified session, at most only one JobRun instance is active at any point in time.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
activeboolean
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

sessionstring(uuid)
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/planned-jobs/?active=true&ordering=string&page=0&page_size=0&search=string&session=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?page=4"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?page=2"
resultsArray of objects(JobRun)required
results[].​idintegerread-onlyrequired
results[].​titlestring<= 400 charactersrequired
results[].​descriptionstring
results[].​sessionstring(uuid)required
results[].​activeboolean
results[].​created_atstring(date-time)read-onlyrequired
results[].​updated_atstring(date-time)read-onlyrequired
results[].​stepsArray of objects(Step)required
results[].​steps[].​idintegerread-onlyrequired
results[].​steps[].​titlestring<= 400 charactersrequired
results[].​steps[].​descriptionstring
results[].​steps[].​statusstring(StepStatusEnum)
  • completed - Completed
  • failed - Failed
  • pending - Pending
Enum"completed""failed""pending"
results[].​steps[].​positioninteger[ 0 .. 2147483647 ]required
results[].​steps[].​jobintegerrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

ai_mentor_orgs_users_planned_jobs_retrieve

Request

Endpoints for viewing jobs and their status A job run refers to a task with steps that an agent is going to undertake. You can filter job runs by their status. Note that for a single user and a specified session, at most only one JobRun instance is active at any point in time.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this job run.

orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/planned-jobs/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idintegerread-onlyrequired
titlestring<= 400 charactersrequired
descriptionstring
sessionstring(uuid)required
activeboolean
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
stepsArray of objects(Step)required
steps[].​idintegerread-onlyrequired
steps[].​titlestring<= 400 charactersrequired
steps[].​descriptionstring
steps[].​statusstring(StepStatusEnum)
  • completed - Completed
  • failed - Failed
  • pending - Pending
Enum"completed""failed""pending"
steps[].​positioninteger[ 0 .. 2147483647 ]required
steps[].​jobintegerrequired
Response
application/json
{
  "id": 0,
  "title": "string",
  "description": "string",
  "session": "3f2c4c37-8bf1-47a5-bf05-0490dc5c033d",
  "active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "steps": [
    { … }
  ]
}

ai_mentor_orgs_users_playwright_scripts_list

Request

Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
is_publicboolean
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

studentinteger[ 0 .. 2147483647 ]

edX user ID

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/playwright-scripts/?is_public=true&ordering=string&page=0&page_size=0&search=string&student=2147483647' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?page=4"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?page=2"
resultsArray of objects(PlayWrightScript)required
results[].​idintegerread-onlyrequired
results[].​platforminteger or nullread-onlyrequired
results[].​studentinteger or null[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

results[].​titlestring<= 400 charactersrequired
results[].​descriptionstring<= 400 characters
results[].​scriptstringrequired
results[].​is_publicbooleanread-onlyrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com