/enable: Enable AI Services

Example usage

The following is a sample ArcGIS Enterprise POST request for the enable operation:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
POST /<context>/sharing/rest/portals/0123456789ABCDEF/aiServices/enable HTTP/1.1
Host: organization.example.com
Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Length: []

------WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Disposition: form-data; name="username"

agolUser
------WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Disposition: form-data; name="password"

agol.pass
------WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Disposition: form-data; name="authenticationUrl"

https://arcgis.com/sharing/rest/generateToken
------WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Disposition: form-data; name="f"

pjson
------WebKitFormBoundaryKkUYxki4o00zqwAV
Content-Disposition: form-data; name="token"

<token>
------WebKitFormBoundaryKkUYxki4o00zqwAV--

Description

The enable operation adds and stores ArcGIS Online credentials for the purpose of using AI assitants. Though the usage of AI assistants can be enabled using the Update Settings operation, which enables AI-related endpoints and information to be accessible in the API, the organization must have access to an ArcGIS Online organizational account to fully enable the use of AI tools. AI assistants do not consume credits. This operation can only be performed by members assigned the default administrator role.

If credentials need to be updated, the original credentials can be removed using the Disable AI Services operation before adding and storing the updated credentials with this operation.

It is recommended that the workflow for enabling AI assistants, storing credentials, and updating credentials is performed in the Settings tab of the Organization page on the portal site.

Request parameters

JSON Response example

1
2
3
{
  "success": true
}