Skip to main content

System Integration API Reference

API reference for user management, log viewing, master data management, shared memory search, and project operations. For end-user-facing APIs (Chat / Conversations / Files / Search / public master data), see the User API Reference. For MCP / A2A connection methods, see the Connection Methods Guide.

SaaS Edition Only

All endpoints documented in this reference are available only in the SaaS edition. On the Marketplace edition, administrative operations are performed exclusively through the admin console.

Base URL​

All API requests are sent to the following base URL.

SaaS
https://api.fd.agenticstar.tm.softbank.jp/api

Endpoint paths in this document are relative to the base URL.

Authentication​

All API requests require a Bearer token in the Authorization header.

Authorization: Bearer <access_token>

If the token is invalid or missing, 401 Unauthorized is returned. Some endpoints require additional scopes. If the required scope is missing, 403 Forbidden is returned.

For details on obtaining tokens and scope assignment, see the Authentication Guide and Authentication API Reference (SaaS).

Common Rules​

These rules apply to the APIs on this page.

How requests are handled​

The APIs on this page handle requests as follows. See each endpoint's description and error responses for endpoint-specific handling.

What you sentHow it is handled
Query parameters and body fields not in the specificationIgnored. However, even items not listed on this page may return 400 Bad Request if their type or value is wrong, when the service accepts them
An invalid value for a query parameter in the specification400 Bad Request
An invalid URL encoding in a path parameter value (a % sequence)400 Bad Request (invalid_parameter)
A malformed JSON body400 Bad Request (invalid_body)
A body other than Content-Type: application/json, or a body with an unsupported character set (charset), sent to an endpoint that accepts a JSON body415 Unsupported Media Type (unsupported_media_type)
A body field of the wrong type400 Bad Request

If reading the body results in 400 (malformed JSON and so on) or 413 (the size limit was exceeded and so on), that is returned before 415.

Responses carry an x-request-id header. The service assigns this value; a value you send in the request is not used. Please tell us this value when you contact us.

Pagination​

List retrieval endpoints use one of two schemes. Which one applies is fixed per endpoint. Organization and job type lists do not support pagination and always return all records.

Page-based​

ParameterTypeDescription
limitintegerNumber of items per page. 1 to 100 (default 25)
pageintegerPage number. 1 or greater (default 1)

Responses include total, limit, page, and hasMore. When hasMore is true, increase page by 1 to retrieve the next page.

curl
# Page 1
curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users?limit=25&page=1" \
-H "Authorization: Bearer <access_token>"

# Page 2
curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users?limit=25&page=2" \
-H "Authorization: Bearer <access_token>"

Endpoints using this scheme: the users list and the log lists (audit logs, operation audit logs, LLM logs, LLM Gateway logs, LLM Gateway operation audit, access logs, and guardrail alerts).

Cursor-based​

ParameterTypeDescription
limitintegerNumber of items per page (1-100). Defaults to 50
cursorstringCursor value for the next page. Pass back the cursor from the previous response as-is

Responses include hasMore. When it is true, pass the cursor value in the next request to retrieve the next page. Treat cursor as opaque: do not interpret it, just pass the previous value back.

Endpoints using this scheme: the project list and the user action audit list. They do not use page (it is ignored if specified).

Shared Memory SaaS​

Searches shared memory (knowledge) based on organization and job role.

Endpoint List​

メソッドエンドポイント説明スコープ
POST/v1/admin/memory/querySearch shared memorysharedmemory:query

POST/v1/admin/memory/query

Search shared memory.

Request Body​

パラメータ型必須説明
querystring必須Search query (max 500 characters)
orgIdstring—Organization ID (max 100 characters). If specified, organization-scoped memory is included in the search
jobRolestring—Job role (max 100 characters). If specified, role-scoped memory is included in the search

Request Example​

Search shared memory
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/memory/query \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{"query": "How to create a sales report", "orgId": "sales"}'

Response Fields (200 OK)​

FieldTypeDescription
memoriesarrayArray of memory objects
memories[].textstringMemory content text
memories[].typestring"knowledge"
memories[].scopestringOne of "organization", "role", or "global"
memories[].createdAtstring | nullCreation date and time (ISO 8601)
memories[].scorenumber?Relevance score. Field is omitted when score is not available

Response Headers​

HeaderDescription
X-RateLimit-LimitMonthly request limit
X-RateLimit-RemainingRemaining requests
X-RateLimit-ResetReset time (start of next month, ISO 8601)

Response Example​

JSON
{
"memories": [
{
"text": "Sales reports can be created from the 'Monthly Reports' tab in the dashboard",
"type": "knowledge",
"scope": "organization",
"createdAt": "2026-03-15T10:30:00.000Z",
"score": 0.85
}
]
}

Error Response​

StatusDescription
400query is missing, empty, or exceeds 500 characters, or the body is malformed JSON (code: "invalid_body")
415The body Content-Type is not application/json (code: "unsupported_media_type")
403sharedmemory:query scope is missing
429Monthly quota exceeded (error.type: rate_limit_error, error.code: monthly_quota_exceeded)
502Communication error with an upstream service (error.type: upstream_error)
504Upstream service response timeout (error.type: upstream_error, error.code: upstream_timeout)

When the search succeeds with no matches, 200 is returned with an empty memories array. Upstream failures return 502 / 504 instead of an empty array, so an empty array in a 200 response does not indicate a failure.

User Management SaaS​

List, create, delete, change role, approve, revoke approval, suspend and resume, unlock, and change the affiliation and job of users.

Endpoint List​

メソッドエンドポイント説明スコープ
GET/v1/admin/usersList usersusers:read / users:manage
GET/v1/admin/users/:userId/passkeysGet the passkeys of a userusers:read / users:manage
POST/v1/admin/usersCreate a userusers:manage
DELETE/v1/admin/users/:userIdDelete userusers:manage
PUT/v1/admin/users/:userId/roleChange user roleusers:manage
POST/v1/admin/users/:userId/approveApprove userusers:manage
POST/v1/admin/users/:userId/rejectRevoke user approvalusers:manage
POST/v1/admin/users/:userId/suspendSuspend a userusers:manage
POST/v1/admin/users/:userId/resumeResume a suspended userusers:manage
POST/v1/admin/users/:userId/unlockUnlock a userusers:manage
PUT/v1/admin/users/:userId/affiliationChange a user's affiliation and jobusers:manage

GET/v1/admin/users

List users. Supports page-based pagination. Either the users:read or users:manage scope is required (users:manage includes users:read permissions).

Query Parameters​

パラメータ型必須説明
limitinteger—Number of items to fetch (1–100, default: 25)
pageinteger—Page number (1 or more, default: 1)
rolestring—Role filter: "admin" (administrators only) or "user" (users other than administrators)
is_approvedstring—Approval status filter. "true" or "false". Suspended users are included in true
searchstring—Search string (max 100 characters). Searches by email address, etc.
organizationstring—Organization code filter (exact match on the code, case-sensitive; max 50 characters; alphanumeric, hyphen, underscore)
job_typestring—Job type code filter (exact match on the code, case-sensitive; max 50 characters; alphanumeric, hyphen, underscore)
orderstring—Sort order: "asc" or "desc" (default: "desc"), by registration time. Other values return 400

Request Example​

List users
1curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users?limit=10&is_approved=true" \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
usersarrayArray of user objects
users[].userIdstringUser ID
users[].emailstringEmail address
users[].usernamestringUsername
users[].emailVerifiedbooleanEmail verification status
users[].rolestringRole ("admin" or "user")
users[].statusstringStatus ("unverified", "pending", "approved", or "suspended"). "suspended" is an approved user whose use was suspended in the admin console (cannot sign in)
users[].organizationobject?Organization (value: code, label: name). Field is omitted if not set
users[].jobTypeobject?Job type (value: code, label: name). Field is omitted if not set
users[].biostring?Self-introduction. Field is omitted when not set
users[].createdAtstringCreation date and time (ISO 8601)
users[].lastLoginAtstring?Last login date and time (ISO 8601). Field is omitted if the user has never logged in
users[].idpSyncedbooleanWhether the user is synced from the identity provider (IdP). For a user with true, an organization or job type that is already set cannot be changed with PUT /v1/admin/users/:userId/affiliation (409 affiliation_managed_by_idp)
totalintegerTotal count
limitintegerNumber of items fetched
pageintegerPage number
hasMorebooleanWhether the next page exists
Example Response (200 OK)​
JSON
{
"users": [
{
"userId": "bbbe4306-6975-420b-af47-fb4c8f48b4aa",
"email": "user1@example.com",
"username": "user1@example.com",
"emailVerified": true,
"role": "user",
"status": "approved",
"createdAt": "2026-04-19T13:02:26.198Z",
"idpSynced": false
},
{
"userId": "90b40fd8-a6b8-42b8-ab61-f3b674169b43",
"email": "user2@example.com",
"username": "user2",
"emailVerified": true,
"role": "user",
"status": "approved",
"organization": { "value": "sales", "label": "Sales" },
"jobType": { "value": "engineer", "label": "Engineer" },
"createdAt": "2026-04-17T07:09:47.484Z",
"idpSynced": true
},
{
"userId": "463e2c25-5a80-4362-b77e-941df96fb1f2",
"email": "admin@example.com",
"username": "admin@example.com",
"emailVerified": true,
"role": "admin",
"status": "approved",
"createdAt": "2026-04-17T07:02:41.015Z",
"lastLoginAt": "2026-04-17T07:18:17.488Z",
"idpSynced": false
}
],
"total": 132,
"limit": 3,
"page": 1,
"hasMore": true
}

Error Response​

StatusDescription
400Invalid query parameters
403users:read or users:manage scope is missing

GET/v1/admin/users/:userId/passkeys

Get the list of passkeys registered by a user. Requires either the users:read or users:manage scope. Passkeys are deleted in the admin console (this API cannot delete them).

Path Parameters​

パラメータ型必須説明
userIdstring必須User ID

Request Example​

List user passkeys
1curl https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users/bbbe4306-6975-420b-af47-fb4c8f48b4aa/passkeys \
2-H "Authorization: Bearer <access_token>"

Response Fields​

FieldTypeDescription
passkeysarrayArray of passkeys (all of them)
passkeys[].credentialIdstringID of the passkey
passkeys[].labelstring | nullName of the passkey
passkeys[].createdAtstring | nullWhen it was registered (ISO 8601)
passkeys[].lastUsedAtstring | nullWhen it was last used (ISO 8601). null if it has not been used
hasMorebooleanAlways false (all of them are returned)
Example Response (200 OK)​
JSON
{
"passkeys": [
{
"credentialId": "AbCdEf0123456789_-AbCdEf0123456789_-AbCdEf0",
"label": "Work PC",
"createdAt": "2026-10-01T02:30:00.000Z",
"lastUsedAt": "2026-11-17T23:45:10.000Z"
}
],
"hasMore": false
}

Error Responses​

StatusDescription
403Missing users:read or users:manage scope
404User not found

POST/v1/admin/users

Creates one user. Requires the users:manage scope. The created user is approved (status is "approved") and counts toward the contracted number of users.

  • If you do not send password, a temporary password is generated and returned once, as temporaryPassword, in the response to the creation. It cannot be read later, so pass it on to the user. This response has Cache-Control: no-store.
  • The notification email (sendNotificationEmail) does not contain the password.
  • Creating users with the same email address at the same time, or creating users at the same time when one more user is left within the contracted number, can give 500 or create users beyond the limit. Create users one after another.

Request Body​

パラメータ型必須説明
emailstring必須Email address. Leading and trailing whitespace is removed and it is lowercased (up to 255 characters)
displayNamestring必須Display name (up to 255 characters). Leading and trailing whitespace is removed, and < and > are removed
rolestring必須"admin" or "user"
organizationstring必須Organization code (a value from GET /v1/organizations)
jobstring必須Job type code (a value from GET /v1/job-types)
biostring—Bio (up to 255 characters). Leading and trailing whitespace is removed, and < and > are removed
passwordstring—The first password. 400 if it does not meet the password rules. If omitted, a temporary password is generated and returned in temporaryPassword of the response
temporaryboolean—Whether the user must change the password at the first sign-in. If omitted, true when password is not sent, and false when it is sent
sendNotificationEmailboolean—Whether to notify the user of the creation by email. If omitted, true. In an environment that cannot send email, it is not sent and emailSent in the response is false

Request Example​

Create user
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{"email": "new.user@example.com", "displayName": "New User", "role": "user", "organization": "ORG001", "job": "JOB01"}'

Response Fields (201 Created)​

FieldTypeDescription
userobjectThe created user. The same fields as users[] in List Users (status is "approved", and idpSynced is false)
emailSentbooleanWhether the notification email was sent
temporaryPasswordstring?Only when password was not sent. The generated temporary password (returned only once, in this response)
Response Example (201 Created)​
JSON
{
"user": {
"userId": "5d1c9b2e-8f4a-4c3b-9e7d-1a2b3c4d5e6f",
"email": "new.user@example.com",
"username": "new.user@example.com",
"emailVerified": true,
"role": "user",
"status": "approved",
"organization": { "value": "ORG001", "label": "Sales" },
"jobType": { "value": "JOB01", "label": "Engineer" },
"createdAt": "2026-11-10T09:00:00.000Z",
"idpSynced": false
},
"emailSent": true,
"temporaryPassword": "<temporary password>"
}

Error Responses​

StatusDescription
400email, displayName, role, organization, or job is missing; any of them or bio is not a string, empty, or only whitespace (for displayName, organization, job, and bio, also a value that is only whitespace after < and > are removed); role is not "admin" or "user"; displayName or bio is longer than 255 characters; password is empty or only whitespace; temporary or sendNotificationEmail is not a boolean; the email address is malformed; an organization or job type code is wrong; or the password does not meet the rules (code: "invalid_parameter")
400The body is malformed JSON or not a JSON object (code: "invalid_body")
415The body Content-Type is not application/json (code: "unsupported_media_type")
401The token is invalid or missing (code: "invalid_token")
403Missing users:manage scope (code: "insufficient_scope")
409A user with the same email address exists (code: "user_exists"; param is email). Use a different email address
409The contracted number of users has been reached (code: "conflict")
429The limit on requests per source IP address (30 per hour) was exceeded (code: "rate_limit_exceeded"). Wait a moment and send it again
500, 502, 504The user may have been created. Check with GET /v1/admin/users?search=<email> before sending again (if it was created, sending again gives 409 user_exists). If it was created and you did not receive the temporary password, the user sets one from "Forgot password?" on the sign-in screen. In an environment that cannot send email, set the password again in the admin console
503The contracted number of users cannot be checked. Wait a moment and send it again

DELETE/v1/admin/users/:userId

Delete a user. A deleted user disappears from the admin console, the chat screens and the API, and this cannot be undone. To have the user's archived conversations, per-conversation work notes and per-user settings records deleted as well, see the administrator guide. Requires users:manage scope. Access tokens issued to the user before the deletion may remain usable until they expire (the expires_in returned when they were obtained).

Path Parameters​

パラメータ型必須説明
userIdstring必須User ID

Request Example​

Delete user
1curl -X DELETE https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users/USER_ID \
2-H "Authorization: Bearer <access_token>"
Response Example (200 OK)​
JSON
{ "userId": "abc123", "deleted": true }

Error Responses​

StatusDescription
403Missing users:manage scope
404The specified user was not found (including already deleted)
429The limit on requests per source IP address (10 per minute) was exceeded (code: "rate_limit_exceeded"). Wait a moment and send it again
500Some of the user's data could not be deleted, so the deletion was stopped (code: "user_delete_incomplete"). The user is kept. Delete it again

PUT/v1/admin/users/:userId/role

Change a user's role. Only users with status "approved", and "suspended" users whose emailVerified is true, can have their role changed.

Behavior on Role Change
  • When demoting to user: The target user's existing sessions are not ended automatically. The permissions in access tokens that were already issued do not change until they expire.
  • When promoting to admin: The target user's existing sessions continue, and the new permissions take effect in tokens issued after the promotion.

Path Parameters​

パラメータ型必須説明
userIdstring必須User ID

Request Body​

パラメータ型必須説明
rolestring必須The role to change to. "admin" or "user"

Request Example​

Change user role
1curl -X PUT https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users/USER_ID/role \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{"role": "admin"}'
Response Example (200 OK)​
JSON
{ "userId": "abc123", "changed": true }

Error Response​

StatusDescription
400role is missing or invalid, the body is malformed JSON (code: "invalid_body"), or the target user is neither "approved" nor a "suspended" user whose emailVerified is true
415The body Content-Type is not application/json (code: "unsupported_media_type")
403users:manage scope is missing
404User not found
409Another update of the same user (approval, role change, profile update, and so on) is in progress (code: "conflict"). Wait a moment and send it again
429The limit on requests per source IP address (100 per minute) was exceeded (code: "rate_limit_exceeded"). Wait a moment and send it again
500The role change could not be finished (code: "internal_error"). Get the user again to check the current role, and send the same change again if needed

POST/v1/admin/users/:userId/approve

Approve a user. Only users with status "pending" can be approved. A user whose approval was revoked (stopped) is also shown as "pending" and can be approved; approving lets the user sign in again and the data is still there, but what the revocation stopped (running conversations, personal schedules, and the patrols and runs of projects the user owns) and the deleted connections to external services are not restored automatically.

note

When approval succeeds, an approval notification email is automatically sent to the target user's email address.

Path Parameters​

パラメータ型必須説明
userIdstring必須User ID

Request Body (optional)​

パラメータ型必須説明
reasonstring—Reason for the approval. If it is not empty, it is recorded in the user information

Request Example​

Approve user
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users/USER_ID/approve \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{}'
Response Example (200 OK)​
JSON
{ "userId": "abc123", "approved": true }

Error Responses​

StatusDescription
400User status is not "pending" (cannot approve: the email address has not been verified, or the user is already approved, including suspended users)
400reason is not a string, or the body is malformed JSON or not a JSON object (code: "invalid_body")
415The body Content-Type is not application/json (code: "unsupported_media_type")
403Missing users:manage scope
404User not found
429The limit on requests per source IP address (10 per minute) was exceeded (code: "rate_limit_exceeded"). Wait a moment and send it again
409After you got the user, it was approved by another operation, the contracted number of users was reached, or another update of the same user is in progress (code: "conflict")
500The approval was not applied, because the change could not be passed to the chat; the user is not approved yet (code: "user_suspension_incomplete"). Send the same request again; it can be repeated

POST/v1/admin/users/:userId/reject

Revoke a user's approval. Only users with status "approved", and "suspended" users whose emailVerified is true, can have their approval revoked (a user whose approval was already revoked can be revoked again; it is a retry). Revoking disables the user, who can no longer sign in, and removes the user from the contracted number of accounts. Conversations, files, schedules and other data are kept. Revoking stops the same things as suspending (/suspend): running conversations and personal schedules, the patrols and open runs of projects the user owns, and the user's connections to external services are deleted. Approving the user again (approve) does not restore them automatically. Suspending (/suspend) keeps the user counted in the number of accounts; revoking removes the user from it. After revocation, the status is shown as "pending". Access tokens issued to the user before the revocation may remain usable until they expire (the expires_in returned when they were obtained).

note

A notification email is automatically sent to the target user's email address once, when an approved user is revoked.

Path Parameters​

パラメータ型必須説明
userIdstring必須User ID

Request Example​

Reject user
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users/USER_ID/reject \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{}'
Response Example (200 OK)​
JSON
{ "userId": "abc123", "status": "pending" }

Error Responses​

StatusDescription
400The user is neither "approved" nor a "suspended" user whose emailVerified is true (cannot revoke). A user whose approval was already revoked can be revoked again (a retry; no email is sent)
403Missing users:manage scope
404User not found
429The limit on requests per source IP address (10 per minute) was exceeded (code: "rate_limit_exceeded"). Wait a moment and send it again
409Another update of the same user is in progress (code: "conflict")
500The approval is revoked, but the stop of use could not be passed to the chat (code: "user_suspension_incomplete"). The user stays disabled and unapproved. Send the same request again to retry the stop

POST/v1/admin/users/:userId/suspend

Suspend a user. The approval status and data are kept, and the status in the list becomes "suspended". A suspended user cannot sign in. It also tries to end the user's signed-in sessions (if they cannot be ended, the suspension still succeeds, and sending the same request again tries again). Suspending also stops the user's running conversations and personal scheduled runs, deletes the user's own connections to external services (project connections are kept), and stops the sweeps and open workflow runs of the projects the user owns (the project definitions are kept). Resuming the user does not restore what was stopped. In a project owned by a suspended user, starting a workflow run and resuming a closed run are refused with 409 Conflict (principal_suspended). Only approved users can be suspended. Sending the same operation again gives the same result. A token issued through the tenant cannot suspend the user of its own idp.sub (409).

Path Parameters​

パラメータ型必須説明
userIdstring必須User ID

No body is needed (a body is not used even if sent).

Request Example​

Suspend user
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users/USER_ID/suspend \
2-H "Authorization: Bearer <access_token>"
Response Example (200 OK)​
JSON
{ "userId": "abc123", "suspended": true }

Error Responses​

StatusDescription
400The body is malformed JSON (code: "invalid_body")
401The token is invalid or missing (code: "invalid_token")
403Missing users:manage scope (code: "insufficient_scope")
404User not found (code: "user_not_found")
409The user cannot be suspended (not approved, deleted, or permanently locked), the token tried to suspend the user of its own idp.sub, or another update of the same user is in progress (code: "conflict"). The error message and its guidance tell which one applies
429The limit on requests per source IP address (10 per minute) was exceeded (code: "rate_limit_exceeded"). Wait a moment and send it again
500The suspension was not fully applied (sign-in was stopped, but the change did not reach chat) (code: "user_suspension_incomplete"). Send the same request again
500Another error (code: "internal_error"). Send the same request again

POST/v1/admin/users/:userId/resume

Resume a suspended user. Sending the same operation again gives the same result.

Path Parameters​

パラメータ型必須説明
userIdstring必須User ID

No body is needed (a body is not used even if sent).

Request Example​

Resume user
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users/USER_ID/resume \
2-H "Authorization: Bearer <access_token>"
Response Example (200 OK)​
JSON
{ "userId": "abc123", "suspended": false }

Error Responses​

StatusDescription
400The body is malformed JSON (code: "invalid_body")
401The token is invalid or missing (code: "invalid_token")
403Missing users:manage scope (code: "insufficient_scope")
404User not found (code: "user_not_found")
409The user cannot be resumed (not approved, deleted, or permanently locked), or another update of the same user is in progress (code: "conflict"). The error message and its guidance tell which one applies
429The limit on requests per source IP address (10 per minute) was exceeded (code: "rate_limit_exceeded"). Wait a moment and send it again
500Resuming was not fully applied, and the user is still suspended (code: "user_suspension_incomplete"). Send the same request again
500Another error. This is also returned when chat was resumed but sign-in could not be resumed (code: "internal_error"). Send the same request again

POST/v1/admin/users/:userId/unlock

Unlock a user who was locked out by failed sign-ins. If the user was not locked, nothing changes and wasLocked is false.

Path Parameters​

パラメータ型必須説明
userIdstring必須User ID

No body is needed (a body is not used even if sent).

Request Example​

Unlock user
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users/USER_ID/unlock \
2-H "Authorization: Bearer <access_token>"
Response Example (200 OK)​
JSON
{ "userId": "abc123", "wasLocked": true }

Error Responses​

StatusDescription
400The body is malformed JSON (code: "invalid_body")
401The token is invalid or missing (code: "invalid_token")
403Missing users:manage scope (code: "insufficient_scope")
404User not found (code: "user_not_found")
409Another update of the same user is in progress (code: "conflict"). Wait a moment and send it again
429The limit on requests per source IP address (100 per minute) was exceeded (code: "rate_limit_exceeded"). Wait a moment and send it again
500The unlock could not be finished (code: "internal_error"). Send the same request again

PUT/v1/admin/users/:userId/affiliation

Change a user's affiliation (organization code) and job (job type code). Both are required. Look up the codes with GET /v1/organizations and GET /v1/job-types. The response has the values before and after the change (null for a previous value that was not set). Changing the affiliation removes the user's organization admin role and organization operations role in organizations other than the new one (the auditor role is kept). After a 500, the affiliation and job may already have changed. Sending the same request again redoes the cleanup of organization roles. For a user synced from the identity provider (IdP) (users[].idpSynced is true in GET /v1/admin/users), an organization or job type that is already set cannot be changed (409 affiliation_managed_by_idp). Change the organization and job type in the identity provider (IdP) that syncs this user. To fill in a value that is not set yet, send the current value for the one that is already set (users[].organization.value and users[].jobType.value in GET /v1/admin/users). An invalid code returns 400 before this check.

Path Parameters​

パラメータ型必須説明
userIdstring必須User ID

Request Body​

パラメータ型必須説明
organizationstring必須Organization code (a value from GET /v1/organizations)
jobstring必須Job type code (a value from GET /v1/job-types)

Request Example​

Change user affiliation
1curl -X PUT https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/users/USER_ID/affiliation \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{"organization": "ORG002", "job": "JOB01"}'
Response Example (200 OK)​
JSON
{
"userId": "abc123",
"previous": { "organization": "ORG001", "job": null },
"current": { "organization": "ORG002", "job": "JOB01" }
}

Error Responses​

StatusDescription
400organization or job is missing or not a string, or an organization or job type code is wrong (code: "invalid_parameter")
400The body is malformed JSON or not a JSON object (code: "invalid_body")
415The body Content-Type is not application/json (code: "unsupported_media_type")
401The token is invalid or missing (code: "invalid_token")
403Missing users:manage scope (code: "insufficient_scope")
404User not found (code: "user_not_found")
409Another update of the same user is in progress (code: "conflict"). Wait a moment and send it again
409The organization and job type of this user are synced from the identity provider (IdP) and cannot be changed (code: "affiliation_managed_by_idp"). Change the organization and job type in the identity provider (IdP) that syncs this user. To fill in a value that is not set yet, send the current value for the one that is already set
429The limit on requests per source IP address (100 per minute) was exceeded (code: "rate_limit_exceeded"). Wait a moment and send it again
500The change of affiliation and job could not be finished (code: "internal_error"). The affiliation and job may already have changed. Sending the same request again redoes the cleanup of organization roles

Logs SaaS​

View audit logs, operation audit logs, user action audit, LLM logs, LLM Gateway logs, LLM Gateway operation audit, access logs (records of outbound communication that was allowed or blocked), and guardrail alerts. The user action audit list uses cursor-based pagination and the other lists use page-based pagination. All lists support date range filters.

Endpoint List​

メソッドエンドポイント説明スコープ
GET/v1/admin/audit-logsList audit logslogs:read
GET/v1/admin/user-action-logsList user action auditlogs:read
GET/v1/admin/action-audit-logsList operation audit logslogs:read
GET/v1/admin/llm-logsList LLM logslogs:read
GET/v1/admin/llm-gateway-logsList LLM Gateway logslogs:read
GET/v1/admin/llm-gateway-action-logsList LLM Gateway operation auditlogs:read
GET/v1/admin/access-logsList access logslogs:read
GET/v1/admin/guardrail-alertsList guardrail alertslogs:read

Common Query Parameters​

パラメータ型必須説明
limitinteger—Number of items to fetch (1–100, default: 25. For the user action audit, default: 50)
pageinteger—Page number (1 or more, default: 1). Not used for the user action audit (use cursor)
fromstring—Start date (an existing date in YYYY-MM-DD format, UTC). A value in another format, a date that does not exist, or a non-string value returns 400
tostring—End date (an existing date in YYYY-MM-DD format, UTC). Includes the end of the specified day. A value in another format, a date that does not exist, or a non-string value returns 400
orderstring—Sort order: "asc" or "desc" (default: "desc"), by the time column of each log. Other values return 400. Access logs and the user action audit are always newest first, and order is ignored

GET/v1/admin/audit-logs

List audit logs. By default, returned in descending order of creation date (use order for ascending).

Filter Query Parameters​

パラメータ型必須説明
resourcestring—Exact match on the resource (resource)
actionstring—Exact match on the action (action)
user_idstring—Exact match on the ID of the user who performed the operation (userId)

Request Example​

List audit logs
1curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/audit-logs?limit=10&from=2026-04-01&to=2026-04-15" \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
auditLogsarrayArray of audit log objects
auditLogs[].auditLogIdstringAudit log ID
auditLogs[].resourcestringResource operated on (e.g. users/show, config/organizations/create, config/job-types/edit)
auditLogs[].actionstringOperation action (approve / reject / promote / demote / create / update / delete / reset-password, etc.). For records whose meta has an action, that value (same as shown in the admin console)
auditLogs[].metaobject | nullAdditional metadata
auditLogs[].userIdstringUser ID who performed the operation. For operations with a system integration token (Client Credentials flow), client:<client ID>
auditLogs[].userEmailstring | nullEmail address of the user
auditLogs[].userNamestring | nullDisplay name of the user. For operations with a system integration token (Client Credentials flow), the client name
auditLogs[].ipAddressstring | nullIP address
auditLogs[].userAgentstring | nullUser-Agent
auditLogs[].createdAtstringCreation date and time (ISO 8601)
totalintegerTotal count
limitintegerNumber of items fetched
pageintegerPage number
hasMorebooleanWhether the next page exists
Example Response (200 OK)​
JSON
{
"auditLogs": [
{
"auditLogId": "6b4366a3-791d-4f60-a9ef-24bdb3303e36",
"resource": "users/list",
"action": "approve",
"meta": {
"userName": "user2@example.com",
"timestamp": "2026-04-19T13:03:27.238Z",
"isApproved": true
},
"userId": "41b9fcf1-958d-4a86-a863-804b69224a1d",
"userEmail": "admin@example.com",
"userName": "admin@example.com",
"ipAddress": "203.0.113.140",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/146.0.0.0 Safari/537.36",
"createdAt": "2026-04-19T13:03:27.479Z"
},
{
"auditLogId": "c14d6065-7c35-44f6-8eea-033ede09bf3a",
"resource": "users/show",
"action": "delete",
"meta": {
"userName": "user1@example.com",
"timestamp": "2026-04-19T05:04:19.745Z",
"userEmail": "user1@example.com"
},
"userId": "client:billing-integration",
"userEmail": "service-account-client@federation.invalid",
"userName": "Billing integration",
"ipAddress": "198.51.100.23",
"userAgent": "Mozilla/5.0 (...)",
"createdAt": "2026-04-19T05:04:19.876Z"
},
{
"auditLogId": "f84ef377-9d75-4875-9958-b084c91a3c9b",
"resource": "organizations",
"action": "delete",
"meta": {},
"userId": "client:billing-integration",
"userEmail": "service-account-client@federation.invalid",
"userName": "Billing integration",
"ipAddress": "198.51.100.23",
"userAgent": "Mozilla/5.0 (...)",
"createdAt": "2026-04-19T05:02:01.736Z"
}
],
"total": 1537,
"limit": 3,
"page": 1,
"hasMore": true
}

GET/v1/admin/user-action-logs

List the user action audit: records of actions users performed in the chat (opening, creating or deleting conversations, files, shares and so on). Always newest first, with cursor-based pagination (limit is 1–100, default 50). Message content is not recorded. The “Metadata” shown on the screen (fingerprinted IP addresses and user agents, and so on) is not returned.

  • Without a period (from and to), the last 30 days are returned. Without from only, the 30 days up to the to date; without to only, up to now. A from later than to returns 400.
  • From the second page on, send the same user_id and action as the first page together with cursor. Changing the conditions changes the range and can cause duplicate or missing items. The period of the first page is kept in cursor, so from and to sent with later pages do not change it.
  • Even when fewer items than limit are returned, there are more while hasMore is true.

Filter Query Parameters​

パラメータ型必須説明
user_idstring—Exact match on the ID of the user who acted (userId), up to 128 characters
actionstring—Exact match on the action (action), up to 64 characters

An empty value does not filter. A value of only whitespace, a value with leading or trailing whitespace, a value that is too long, or a parameter given twice or more returns 400.

Request Example​

List user action logs
1curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/user-action-logs?limit=50&from=2026-11-01&to=2026-11-10&action=export" \
2-H "Authorization: Bearer <access_token>"

For the second page, send the cursor from the first response with the same filters (action in this example).

curl
curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/user-action-logs?limit=50&action=export&cursor=<cursor from the previous response>" \
-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
userActionLogsarrayArray of user action audit records
userActionLogs[].userActionLogIdstringUser action audit ID
userActionLogs[].occurredAtstringWhen the action took place (ISO 8601)
userActionLogs[].eventTypestringType, in the form user_action.<resource>.<action> (e.g. user_action.conversation.export)
userActionLogs[].userIdstring | nullID of the user who acted. null when unknown
userActionLogs[].actorKindstringActor (human: a user / unknown: the user is not known)
userActionLogs[].resourcestring | nullResource (e.g. conversation, share, session)
userActionLogs[].actionstring | nullAction (e.g. export, delete)
userActionLogs[].decisionstringResult (e.g. allow, deny, rejected, not_found, error, aborted)
userActionLogs[].requestIdstring | nullRequest ID
userActionLogs[].conversationIdstring | nullConversation ID
userActionLogs[].systemVersionstring | nullSystem version when recorded
hasMorebooleanWhether a next page exists
cursorstring?Only when hasMore is true. Cursor value for the next page
Response Example (200 OK)​
JSON
{
"userActionLogs": [
{
"userActionLogId": "48213",
"occurredAt": "2026-11-10T02:15:30.123Z",
"eventType": "user_action.conversation.export",
"userId": "41b9fcf1-958d-4a86-a863-804b69224a1d",
"actorKind": "human",
"resource": "conversation",
"action": "export",
"decision": "allow",
"requestId": "7f3c2a1e-9b8d-4c6f-a5e4-3d2c1b0a9f8e",
"conversationId": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
"systemVersion": "3.4.0"
}
],
"hasMore": true,
"cursor": "eyJjIjoiTWpBeU5pMHhNUzB4TUZRd01qb3hOVG96TUM0eE1qTmFmRFE0TWpFeiIsImYiOiIyMDI2LTExLTAxVDAwOjAwOjAwLjAwMFoiLCJ0IjoiMjAyNi0xMS0xMVQwMDowMDowMC4wMDBaIiwiZSI6dHJ1ZX0"
}

Error Responses​

StatusDescription
400limit is not 1–100; from or to is not an existing date in YYYY-MM-DD format; from is later than to; user_id or action is only whitespace, has leading or trailing whitespace, is too long, or is given twice or more; or cursor is invalid (not a value from a previous response) (code: "invalid_parameter")
400The service did not accept the period (e.g. to is omitted and from is a date after today) (code: "bad_request")
403Missing logs:read scope (code: "insufficient_scope")

GET/v1/admin/action-audit-logs

List operation audit logs: what users, agents and the system carried out, such as agents' tool calls, allows and denies by execution rules, and approvals. By default, returned in descending order of occurrence time (use order for ascending). The text itself is not recorded. The “Integrity Hash of Record Content”, “Row Hash” and “Metadata” shown on the screen are not returned.

Filter Query Parameters​

パラメータ型必須説明
event_typestring—Exact match on the event type (eventType), e.g. "tool.invoked", "approval.resolved", "gate.resolved", "run.started", "agent.copied"
decisionstring—Exact match on the decision (decision), e.g. "allow", "deny", "completed", "failed", "copied"
sourcestring—Exact match on the source (source), e.g. "worker", "cli-api", "front", "admin", "login", "agent_executor"
actor_typestring—Exact match on the actor type (actorType), e.g. "human", "agent", "system"
actor_kindstring—Exact match on the actor kind (actorKind), e.g. "human", "human_external", "system", "agent", "unknown"
actor_refstring—Exact match on the actor (actorRef)
conversation_idstring—Exact match on the conversation ID (conversationId)
execution_idstring—Exact match on the execution ID (executionId)
root_execution_idstring—Exact match on the execution series ID (rootExecutionId)
project_idstring—Exact match on the project ID (projectId). A value that is not a UUID returns 400
request_idstring—Exact match on the request ID (requestId)

Values are not restricted, and an unknown value matches nothing. An empty value does not filter. A value of only whitespace, a value with leading or trailing whitespace, or a parameter given twice or more returns 400.

Request Example​

List action audit logs
1curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/action-audit-logs?limit=10&from=2026-11-01&to=2026-11-10&source=front" \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
actionAuditLogsarrayArray of operation audit log objects
actionAuditLogs[].actionAuditLogIdstringOperation audit log ID
actionAuditLogs[].occurredAtstring | nullOccurred at (ISO 8601)
actionAuditLogs[].sourcestring | nullSource (e.g. worker, cli-api, front, admin, login, agent_executor)
actionAuditLogs[].eventTypestring | nullEvent type
actionAuditLogs[].actorTypestring | nullActor type (e.g. human, agent, system)
actionAuditLogs[].actorKindstring | nullActor kind (e.g. human, human_external, system, agent, unknown). null for older records
actionAuditLogs[].actorRefstring | nullActor
actionAuditLogs[].onBehalfOfRefstring | nullOn behalf of (whom the action was carried out for)
actionAuditLogs[].resourcestring | nullResource
actionAuditLogs[].actionstring | nullAction
actionAuditLogs[].decisionstring | nullDecision
actionAuditLogs[].reasonstring | nullReason code
actionAuditLogs[].policyIdstring | nullExecution rules ID
actionAuditLogs[].policyVersionstring | nullExecution rules version
actionAuditLogs[].executionIdstring | nullExecution ID
actionAuditLogs[].rootExecutionIdstring | nullExecution series ID. null for older records
actionAuditLogs[].conversationIdstring | nullConversation ID
actionAuditLogs[].projectIdstring | nullProject ID. null for older records
actionAuditLogs[].messageIdstring | nullMessage ID
actionAuditLogs[].requestIdstring | nullRequest ID
actionAuditLogs[].systemVersionstring | nullSystem version
totalintegerTotal count
limitintegerNumber of items fetched
pageintegerPage number
hasMorebooleanWhether a next page exists
Response Example (200 OK)​
JSON
{
"actionAuditLogs": [
{
"actionAuditLogId": "1203344",
"occurredAt": "2026-11-10T03:00:12.456Z",
"source": "front",
"eventType": "agent.copied",
"actorType": "human",
"actorKind": "human",
"actorRef": "41b9fcf1-958d-4a86-a863-804b69224a1d",
"onBehalfOfRef": null,
"resource": "agent:9c8b7a6f-5e4d-4c3b-8a2f-1e0d9c8b7a6f",
"action": null,
"decision": "copied",
"reason": null,
"policyId": null,
"policyVersion": null,
"executionId": null,
"rootExecutionId": null,
"conversationId": null,
"projectId": null,
"messageId": null,
"requestId": null,
"systemVersion": "3.4.0"
}
],
"total": 128,
"limit": 1,
"page": 1,
"hasMore": true
}

Error Responses​

StatusDescription
400limit, page, from, to, or order is invalid; a filter value is only whitespace, has leading or trailing whitespace, or is given twice or more; or project_id is not a UUID (code: "invalid_parameter")
403Missing logs:read scope (code: "insufficient_scope")

GET/v1/admin/llm-logs

List LLM logs. By default, returned in descending order of timestamp (use order for ascending).

Filter Query Parameters​

パラメータ型必須説明
conversation_idstring—Exact match on the conversation ID (conversationId)
servicestring—Exact match on the service (service)
operationstring—Exact match on the operation (operation)
successstring—"true" (succeeded) or "false" (failed). Other values return 400

Request Example​

List LLM logs
1curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/llm-logs?limit=10" \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
llmLogsarrayArray of LLM log objects
llmLogs[].llmLogIdstringLLM log ID
llmLogs[].timestampstring | nullTimestamp
llmLogs[].servicestring | nullService name
llmLogs[].operationstring | nullOperation name
llmLogs[].durationMsnumber | nullProcessing time (milliseconds)
llmLogs[].conversationIdstring | nullConversation ID
llmLogs[].intentTypestring | nullIntent type
llmLogs[].confidenceScorenumber | nullConfidence score
llmLogs[].toolsUsednumber | nullNumber of tool calls — not a list of tool names, and not a count of distinct tools (calling the same tool 5 times gives 5). null means not measured; 0 means the run was measured and made no tool call. The two are distinct — do not treat 0 as null.
llmLogs[].successboolean | nullSuccess/failure
llmLogs[].agentTypestring | nullAgent type
llmLogs[].agentLevelstring | nullAgent level
llmLogs[].taskComplexitystring | nullTask complexity
llmLogs[].currentMessagestring | nullCurrent message
llmLogs[].contextSummarystring | nullContext summary
llmLogs[].suggestedApproachstring | nullSuggested approach
llmLogs[].conversationGoalstring | nullConversation goal
llmLogs[].finalContentstring | nullFinal output content
llmLogs[].metadataobject | nullSupplementary metadata that varies by operation (keys vary)
llmLogs[].createdAtstring | nullCreation date and time
totalintegerTotal count
limitintegerNumber of items fetched
pageintegerPage number
hasMorebooleanWhether the next page exists
Example Response (200 OK)​
JSON
{
"llmLogs": [
{
"llmLogId": "33098",
"timestamp": "2026-04-19T04:12:51.102Z",
"service": "agent-executor",
"operation": "agent.intent.completed",
"durationMs": 5574.6,
"conversationId": "3b72544d-d6b5-4577-b5f3-c39293124a57",
"intentType": "complex_task",
"confidenceScore": 0.95,
"toolsUsed": null,
"success": null,
"agentType": "intent",
"agentLevel": "default",
"taskComplexity": null,
"currentMessage": "Tell me about this URL https://example.com/path",
"contextSummary": "User is asking about a URL.",
"suggestedApproach": "execute_single_tool",
"conversationGoal": "Information about the contents or purpose of the specified URL",
"finalContent": null,
"metadata": {
"message.id": "02038f42-154b-4363-9beb-d31512934ec5",
"task.complexity": "moderate",
"detected_language": "en",
"requires_planning": true
},
"createdAt": "2026-04-18T19:16:16.964Z"
},
{
"llmLogId": "33097",
"timestamp": "2026-04-19T04:12:48.730Z",
"service": "agent-executor",
"operation": "agent.guardrail.completed",
"durationMs": 3170.34,
"conversationId": "3b72544d-d6b5-4577-b5f3-c39293124a57",
"intentType": null,
"confidenceScore": null,
"toolsUsed": null,
"success": null,
"agentType": "intent.guardrails",
"agentLevel": null,
"taskComplexity": null,
"currentMessage": null,
"contextSummary": null,
"suggestedApproach": null,
"conversationGoal": null,
"finalContent": null,
"metadata": { "guardrail_detected": false },
"createdAt": "2026-04-18T19:16:14.619Z"
},
{
"llmLogId": "33096",
"timestamp": "2026-04-19T04:12:33.662Z",
"service": "agent-executor",
"operation": "agent.intent.completed",
"durationMs": 4213.47,
"conversationId": "4d7c798d-2e3e-4d40-86ab-cbb6c685a3fb",
"intentType": "conversation",
"confidenceScore": 1,
"toolsUsed": null,
"success": null,
"agentType": "intent",
"agentLevel": "default",
"taskComplexity": null,
"currentMessage": "Hello",
"contextSummary": "New conversation. User is greeting.",
"suggestedApproach": "conversational_response",
"conversationGoal": "Greeting exchange with the AI assistant",
"finalContent": null,
"metadata": {
"message.id": "cea9dbcc-4723-452a-bdcd-aa5f3a0e9ca6",
"task.complexity": "simple",
"detected_language": "en",
"requires_planning": false
},
"createdAt": "2026-04-18T19:15:59.681Z"
}
],
"total": 33098,
"limit": 3,
"page": 1,
"hasMore": true
}

GET/v1/admin/llm-gateway-logs

List LLM Gateway logs. By default, returned in descending order of creation time (use order for ascending). One request = one row, recording usage such as model, provider, tokens, cost, and latency.

Filter Query Parameters​

パラメータ型必須説明
providerstring—Exact match on the provider (provider)
model_namestring—Exact match on the model name (rows without modelName are compared by resolvedModel)
successstring—"true" (succeeded) or "false" (failed). Other values return 400

Request Example​

List LLM gateway logs
1curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/llm-gateway-logs?limit=10" \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
llmGatewayLogsarrayArray of LLM Gateway log objects
llmGatewayLogs[].llmGatewayLogIdstringLLM Gateway log ID
llmGatewayLogs[].createdAtstring | nullCreation date and time
llmGatewayLogs[].virtualKeyIdstring | nullVirtual key ID (calling client)
llmGatewayLogs[].clientSessionIdstring | nullClient session ID
llmGatewayLogs[].clientAgentIdstring | nullClient agent ID
llmGatewayLogs[].apiFlavorstring | nullAPI flavor
llmGatewayLogs[].modelNamestring | nullModel name (as requested)
llmGatewayLogs[].resolvedModelstring | nullResolved model name
llmGatewayLogs[].providerstring | nullProvider
llmGatewayLogs[].deploymentstring | nullDeployment
llmGatewayLogs[].tierstring | nullTier
llmGatewayLogs[].streamboolean | nullWhether streaming was used
llmGatewayLogs[].successboolean | nullSuccess/failure
llmGatewayLogs[].httpStatusnumber | nullHTTP status
llmGatewayLogs[].errorTypestring | nullError type
llmGatewayLogs[].errorCodestring | nullError code
llmGatewayLogs[].usageStatusstring | nullUsage status
llmGatewayLogs[].latencyMsnumber | nullLatency (milliseconds)
llmGatewayLogs[].inputTokensnumber | nullInput token count
llmGatewayLogs[].outputTokensnumber | nullOutput token count
llmGatewayLogs[].totalTokensnumber | nullTotal token count
llmGatewayLogs[].cachedTokensnumber | nullCached token count
llmGatewayLogs[].cacheCreationInputTokensnumber | nullCache creation input token count
llmGatewayLogs[].reasoningTokensnumber | nullReasoning token count
llmGatewayLogs[].costUsdnumber | string | nullCost (USD)
llmGatewayLogs[].currencystring | nullCurrency
llmGatewayLogs[].metadataobject | nullSupplementary metadata (keys vary)
totalintegerTotal count
limitintegerNumber of items fetched
pageintegerPage number
hasMorebooleanWhether the next page exists

GET/v1/admin/llm-gateway-action-logs

List the LLM Gateway operation audit: a record of operations performed through the LLM Gateway. There are no records if you do not use the LLM Gateway. By default, returned in descending order of occurrence time (use order for ascending). The “Request ID”, “Detail Digest”, “Row Hash” and “Metadata” shown on the screen are not returned.

Filter Query Parameters​

パラメータ型必須説明
event_typestring—Exact match on the event type (eventType), e.g. "auth.denied", "guardrail.blocked", "policy.pii_blocked", "policy.mcp_stripped", "limit.rpm_exceeded", "limit.budget_exceeded"
decisionstring—Exact match on the decision (decision), e.g. "allowed", "denied", "blocked", "degraded", "stripped", "throttled"
api_flavorstring—Exact match on the API flavor (apiFlavor), e.g. "chat", "responses", "messages", "embeddings"
virtual_key_idstring—Exact match on the virtual key ID (virtualKeyId)

Values are not restricted, and an unknown value matches nothing. An empty value does not filter. A value of only whitespace, a value with leading or trailing whitespace, or a parameter given twice or more returns 400.

Request Example​

List LLM gateway action logs
1curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/llm-gateway-action-logs?limit=10&event_type=guardrail.blocked" \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
llmGatewayActionLogsarrayArray of LLM Gateway operation audit objects
llmGatewayActionLogs[].llmGatewayActionLogIdstringLLM Gateway operation audit ID
llmGatewayActionLogs[].occurredAtstring | nullOccurred at (ISO 8601)
llmGatewayActionLogs[].virtualKeyIdstring | nullVirtual key ID (calling client)
llmGatewayActionLogs[].externalRequestIdstring | nullExternal request ID
llmGatewayActionLogs[].apiFlavorstring | nullAPI flavor
llmGatewayActionLogs[].eventTypestring | nullEvent type
llmGatewayActionLogs[].decisionstring | nullDecision
llmGatewayActionLogs[].reasonstring | nullReason code
llmGatewayActionLogs[].modelNamestring | nullModel name (as requested)
llmGatewayActionLogs[].resolvedModelstring | nullResolved model name
llmGatewayActionLogs[].systemVersionstring | nullSystem version
totalintegerTotal count
limitintegerNumber of items fetched
pageintegerPage number
hasMorebooleanWhether a next page exists
Response Example (200 OK)​
JSON
{
"llmGatewayActionLogs": [
{
"llmGatewayActionLogId": "88412",
"occurredAt": "2026-11-10T04:21:07.318Z",
"virtualKeyId": "3f2e1d0c-9b8a-4765-8432-10fedcba9876",
"externalRequestId": null,
"apiFlavor": "chat",
"eventType": "guardrail.blocked",
"decision": "blocked",
"reason": null,
"modelName": "<model ID>",
"resolvedModel": "<model ID>",
"systemVersion": "3.4.0"
}
],
"total": 3,
"limit": 10,
"page": 1,
"hasMore": false
}

Error Responses​

StatusDescription
400limit, page, from, to, or order is invalid; or a filter value is only whitespace, has leading or trailing whitespace, or is given twice or more (code: "invalid_parameter")
403Missing logs:read scope (code: "insufficient_scope")

GET/v1/admin/access-logs

List access logs. Access logs are records of outbound communication that was allowed or blocked. Returned in descending order of timestamp (order cannot be specified).

Filter Query Parameters​

パラメータ型必須説明
authz_resultstring—"allowed" or "denied". Other values return 400

Request Example​

List access logs
1curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/access-logs?limit=10" \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
accessLogsarrayArray of access log objects
accessLogs[].timestampstringTimestamp
accessLogs[].sourceNamespacestring | nullSource namespace
accessLogs[].sourceIpstring | nullSource IP address
accessLogs[].methodstring | nullHTTP method
accessLogs[].hoststring | nullHost name
accessLogs[].pathstring | nullRequest path
accessLogs[].userAgentstring | nullUser-Agent
accessLogs[].statusCodenumber | nullHTTP status code
accessLogs[].durationMsnumber | nullProcessing time (milliseconds)
accessLogs[].authzResultstring | nullAuthorization result
accessLogs[].authzReasonstring | nullAuthorization reason
totalintegerTotal count
limitintegerNumber of items fetched
pageintegerPage number
hasMorebooleanWhether the next page exists
skippedCountintegerNumber of log rows on this page that could not be read (not included in accessLogs; total counts them)
Example Response (200 OK)​
JSON
{
"accessLogs": [
{
"timestamp": "2026-04-19T05:17:36.735896",
"sourceNamespace": "autonomous-agent",
"sourceIp": "127.0.0.1",
"method": "CONNECT",
"host": "optimizationguide-pa.googleapis.com:443",
"path": "",
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/147.0.0.0 Safari/537.36",
"statusCode": 200,
"durationMs": 1,
"authzResult": "allowed",
"authzReason": "allowed: All allow"
},
{
"timestamp": "2026-04-19T03:50:36.766451",
"sourceNamespace": "autonomous-agent",
"sourceIp": "127.0.0.1",
"method": "CONNECT",
"host": "update.googleapis.com:443",
"path": "",
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/147.0.0.0 Safari/537.36",
"statusCode": 200,
"durationMs": 6,
"authzResult": "allowed",
"authzReason": "allowed: All allow"
},
{
"timestamp": "2026-04-19T03:45:48.481023",
"sourceNamespace": "autonomous-agent",
"sourceIp": "127.0.0.1",
"method": "CONNECT",
"host": "optimizationguide-pa.googleapis.com:443",
"path": "",
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/147.0.0.0 Safari/537.36",
"statusCode": 200,
"durationMs": 0,
"authzResult": "allowed",
"authzReason": "allowed: All allow"
}
],
"total": 57806,
"limit": 3,
"page": 1,
"hasMore": true,
"skippedCount": 0
}

GET/v1/admin/guardrail-alerts

Lists guardrail alerts. By default, results are returned in descending order of detection time (use order for ascending).

Filter Query Parameters​

パラメータ型必須説明
statusstring—"open" / "investigating" / "escalated" / "closed" / "false_positive"
source_surfacestring—"agent_executor" / "llm_gateway" / "agent_worker"
resolution_codestring—"policy_violation_confirmed" / "no_action_required" / "escalated_externally" / "detection_error" / "benign_context" / "test_or_synthetic" / "insufficient_information"
detection_typestring—Detection type (a value in detectionTypes, for example "jailbreak_attack" or "harmful_content")
moderation_categorystring—Harmful content category (a key in moderationCategories, for example "Hate", "Violence", or "Sexual")
shield_originstring—"userPrompt" / "documents" / "both" / "unknown"
policy_categorystring—Attack method category (a value of policyCategory)

A value other than those above for status, source_surface, resolution_code, or shield_origin returns 400. detection_type, moderation_category, and policy_category accept any value, and an unknown value matches nothing.

These are records where Prompt Shield (prompt injection and jailbreak attempts) or Text Moderation (harmful content) detected a violation and execution was stopped. The detection surface (sourceSurface) is either AI agent execution (agent_executor) or the LLM Gateway (llm_gateway).

Request Example​

List guardrail alerts
1curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/guardrail-alerts?limit=10&from=2026-08-01&to=2026-08-15" \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
guardrailAlertsarrayArray of guardrail alert objects
guardrailAlerts[].guardrailAlertIdstringGuardrail alert ID
guardrailAlerts[].detectedAtstringDetection time (ISO 8601 format)
guardrailAlerts[].sourceSurfacestringDetection surface (agent_executor: during AI agent execution / llm_gateway: via LLM Gateway / agent_worker: inside the conversation pod)
guardrailAlerts[].detectionTypesarrayDetection types (jailbreak_attack: prompt injection / harmful_content: harmful content)
guardrailAlerts[].promptShieldOriginobject | nullWhere Prompt Shield detected the attack. Contains user_prompt (the user input) and document_indexes (positions in attached documents). Document contents are not included
guardrailAlerts[].moderationCategoriesobject | nullSeverity per category. Hate / Sexual / SelfHarm / Violence on a four-level scale of 0, 2, 4, and 6
guardrailAlerts[].moderationThresholdinteger | nullThreshold used for the decision
guardrailAlerts[].policyOutcomestringPolicy outcome. Currently only blocked (execution stopped)
guardrailAlerts[].policyCategorystring | nullAttack method category (for example prompt_injection, system_prompt_extraction, or credential_request). null for a detection without this category
guardrailAlerts[].responseTemplateCodestring | nullCode of the canned response returned to the user
guardrailAlerts[].statusstringTriage status (open: not yet handled / investigating: investigating / escalated: escalated / closed: resolved / false_positive: false detection)
guardrailAlerts[].resolutionCodestring | nullResolution code
guardrailAlerts[].resolvedAtstring | nullResolution time (ISO 8601 format)
guardrailAlerts[].resolvedBystring | nullUser ID of the administrator who resolved the alert
guardrailAlerts[].createdAtstringCreation time (ISO 8601 format)
guardrailAlerts[].updatedAtstringUpdate time (ISO 8601 format)
totalintegerTotal number of records
limitintegerNumber of items fetched
pageintegerPage number
hasMorebooleanWhether a next page exists
About the users who triggered detections

This API does not return information that identifies the user who triggered a detection (user ID, conversation ID, or message ID). It is intended for reviewing guardrail quality and tracking the status of safety responses, and cannot be used to trace the behavior of individual users.

In addition, detections of SelfHarm alone are not recorded as alerts.

Response Example (200 OK)​
JSON
{
"guardrailAlerts": [
{
"guardrailAlertId": "1f2e3d4c-5b6a-4789-8c9d-0e1f2a3b4c5d",
"detectedAt": "2026-08-13T02:10:00.000Z",
"sourceSurface": "agent_executor",
"detectionTypes": ["harmful_content"],
"promptShieldOrigin": null,
"moderationCategories": {
"Hate": 4,
"Sexual": 0,
"SelfHarm": 0,
"Violence": 0
},
"moderationThreshold": 2,
"policyOutcome": "blocked",
"responseTemplateCode": null,
"status": "open",
"resolutionCode": null,
"resolvedAt": null,
"resolvedBy": null,
"createdAt": "2026-08-13T02:10:00.100Z",
"updatedAt": "2026-08-13T02:10:00.100Z"
},
{
"guardrailAlertId": "2a3b4c5d-6e7f-4890-9a1b-2c3d4e5f6a7b",
"detectedAt": "2026-08-12T09:32:11.000Z",
"sourceSurface": "llm_gateway",
"detectionTypes": ["jailbreak_attack"],
"promptShieldOrigin": {
"user_prompt": true,
"document_indexes": []
},
"moderationCategories": null,
"moderationThreshold": null,
"policyOutcome": "blocked",
"responseTemplateCode": null,
"status": "closed",
"resolutionCode": "policy_violation_confirmed",
"resolvedAt": "2026-08-12T11:05:00.000Z",
"resolvedBy": "8f14e45f-ceea-4d3c-9b2a-1a2b3c4d5e6f",
"createdAt": "2026-08-12T09:32:11.050Z",
"updatedAt": "2026-08-12T11:05:00.000Z"
}
],
"total": 14,
"limit": 2,
"page": 1,
"hasMore": true
}

Master Data Management SaaS​

CRUD operations for organizations and job types. Unlike the read-only master data endpoints (/v1/organizations, /v1/job-types), creation, updates, and deletion require master:manage scope.

Endpoint List​

メソッドエンドポイント説明スコープ
GET/v1/admin/organizationsList organizationsmaster:manage
POST/v1/admin/organizationsCreate organizationmaster:manage
GET/v1/admin/organizations/:identifierGet organization detailmaster:manage
PATCH/v1/admin/organizations/:identifierUpdate organizationmaster:manage
DELETE/v1/admin/organizations/:identifierDelete organizationmaster:manage
GET/v1/admin/job-typesList job typesmaster:manage
POST/v1/admin/job-typesCreate job typemaster:manage
GET/v1/admin/job-types/:identifierGet job type detailmaster:manage
PATCH/v1/admin/job-types/:identifierUpdate job typemaster:manage
DELETE/v1/admin/job-types/:identifierDelete job typemaster:manage

GET/v1/admin/organizations

List organizations. Fetches all records (no pagination).

Request Example​

List organizations (admin)
1curl https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/organizations \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
organizationsarrayArray of organization objects
organizations[].codestringOrganization code
organizations[].namestringOrganization name
organizations[].displayOrderintegerDisplay order
organizations[].isActivebooleanEnabled/disabled
organizations[].createdAtstringCreation date and time
organizations[].updatedAtstringLast updated date and time
hasMorebooleanAlways false (all items are returned)
Example Response (200 OK)​
JSON
{
"organizations": [
{
"code": "sample_org",
"name": "Sample Organization",
"displayOrder": 0,
"isActive": true,
"createdAt": "2025-12-12T10:40:45.220Z",
"updatedAt": "2026-04-13T01:21:57.695Z"
},
{
"code": "sales",
"name": "Sales Division",
"displayOrder": 1,
"isActive": true,
"createdAt": "2025-12-24T19:26:37.000Z",
"updatedAt": "2025-12-24T19:26:37.000Z"
},
{
"code": "engineering",
"name": "Engineering Division",
"displayOrder": 2,
"isActive": true,
"createdAt": "2025-12-24T19:26:37.000Z",
"updatedAt": "2025-12-24T19:26:37.000Z"
},
{
"code": "other",
"name": "Other",
"displayOrder": -1,
"isActive": false,
"createdAt": "2025-12-24T19:26:38.000Z",
"updatedAt": "2026-01-17T19:08:21.630Z"
}
],
"hasMore": false
}

Error Responses​

StatusDescription
403master:manage scope is missing

POST/v1/admin/organizations

Create an organization.

Request Body​

パラメータ型必須説明
codestring必須Organization code (unique). Lowercase letters, digits, and underscores (`_`) only, up to 255 characters. Leading and trailing spaces are removed
namestring必須Organization name (up to 255 characters)
displayOrderinteger—Display order. If omitted, it is the largest positive display order plus 1 (when `code` is `other` it is -1, which displays the item last)
isActiveboolean—Enabled/disabled (default: true)

Request Example​

Create organization
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/organizations \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{
5 "code": "marketing",
6 "name": "Marketing Division",
7 "displayOrder": 3,
8 "isActive": true
9}'
Example Response (201 Created)​
JSON
{
"code": "marketing",
"name": "Marketing Division",
"displayOrder": 3,
"isActive": true,
"createdAt": "2026-04-19T02:15:32.000Z",
"updatedAt": "2026-04-19T02:15:32.000Z"
}

Error Responses​

StatusDescription
400The request body is invalid (code / name is missing, code or name is not a string, isActive is not a boolean, displayOrder is not an integer, code contains characters other than lowercase letters, digits, and underscores, code or name exceeds 255 characters, the body is malformed JSON or not a JSON object (code: "invalid_body"), and so on)
415The body Content-Type is not application/json (code: "unsupported_media_type")
403master:manage scope is missing
409An organization with the same code already exists

GET/v1/admin/organizations/:identifier

Get organization detail. Can be specified by UUID or organization code.

Path Parameters​

パラメータ型必須説明
identifierstring必須Organization UUID or organization code

Request Example​

Get organization
1curl https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/organizations/sales \
2-H "Authorization: Bearer <access_token>"
Example Response (200 OK)​
JSON
{
"code": "sales",
"name": "Sales Division",
"displayOrder": 1,
"isActive": true,
"createdAt": "2025-12-24T19:26:37.000Z",
"updatedAt": "2025-12-24T19:26:37.000Z"
}

Error Responses​

StatusDescription
403master:manage scope is missing
404The specified organization is not found

PATCH/v1/admin/organizations/:identifier

Update an organization. Only name and isActive can be updated.

Path Parameters​

パラメータ型必須説明
identifierstring必須Organization UUID or organization code

Request Body​

パラメータ型必須説明
namestring—Organization name
isActiveboolean—Enabled/disabled

Request Example​

Update organization
1curl -X PATCH https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/organizations/sales \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{
5 "name": "Sales Division",
6 "isActive": true
7}'
Example Response (200 OK)​
JSON
{
"code": "sales",
"name": "Sales Division",
"displayOrder": 1,
"isActive": true,
"createdAt": "2025-12-24T19:26:37.000Z",
"updatedAt": "2026-04-19T02:18:40.000Z"
}

Error Responses​

StatusDescription
400Invalid request body (name exceeds 255 characters, neither name nor isActive provided, name is not a string or isActive is not a boolean, the body is malformed JSON or not a JSON object (code: "invalid_body"), etc.). Fields other than name / isActive are ignored
415The body Content-Type is not application/json (code: "unsupported_media_type")
403master:manage scope is missing
404The specified organization was not found

DELETE/v1/admin/organizations/:identifier

Delete an organization.

Path Parameters​

パラメータ型必須説明
identifierstring必須Organization UUID or organization code

Request Example​

Delete organization
1curl -X DELETE https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/organizations/sales \
2-H "Authorization: Bearer <access_token>"
Response Example (200 OK)​
JSON
{ "code": "sales", "deleted": true }
FieldTypeDescription
codestringThe deleted organization code (returns the path parameter identifier as-is)
deletedbooleanAlways true

Error Responses​

StatusDescription
403master:manage scope is missing
404The specified organization was not found

GET/v1/admin/job-types

List job types. Fetches all records (no pagination). Response fields have the same structure as the organizations list (organizations → jobTypes, organization code → job type code).

Request Example​

List job types
1curl https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/job-types \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
jobTypesarrayArray of job type objects
jobTypes[].codestringJob type code
jobTypes[].namestringJob type name
jobTypes[].displayOrderintegerDisplay order
jobTypes[].isActivebooleanEnabled/disabled
jobTypes[].createdAtstringCreation date and time
jobTypes[].updatedAtstringLast updated date and time
hasMorebooleanAlways false (all items are returned)
Example Response (200 OK)​
JSON
{
"jobTypes": [
{
"code": "engineer",
"name": "Engineer",
"displayOrder": 1,
"isActive": true,
"createdAt": "2025-12-24T19:26:37.000Z",
"updatedAt": "2025-12-24T19:26:37.000Z"
},
{
"code": "sales",
"name": "Sales",
"displayOrder": 2,
"isActive": true,
"createdAt": "2025-12-24T19:26:37.000Z",
"updatedAt": "2025-12-24T19:26:37.000Z"
},
{
"code": "other",
"name": "Other",
"displayOrder": -1,
"isActive": false,
"createdAt": "2025-12-24T19:26:38.000Z",
"updatedAt": "2026-01-17T19:08:21.630Z"
}
],
"hasMore": false
}

Error Responses​

StatusDescription
403master:manage scope is missing

POST/v1/admin/job-types

Create a job type. The request body has the same structure as organization creation.

Request Example​

Create job type
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/job-types \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{
5 "code": "manager",
6 "name": "Manager",
7 "displayOrder": 3,
8 "isActive": true
9}'
Example Response (201 Created)​
JSON
{
"code": "manager",
"name": "Manager",
"displayOrder": 3,
"isActive": true,
"createdAt": "2026-04-19T02:20:15.000Z",
"updatedAt": "2026-04-19T02:20:15.000Z"
}

Error Responses​

StatusDescription
400The request body is invalid (code / name is missing, code or name is not a string, isActive is not a boolean, displayOrder is not an integer, code contains characters other than lowercase letters, digits, and underscores, code or name exceeds 255 characters, the body is malformed JSON or not a JSON object (code: "invalid_body"), and so on)
415The body Content-Type is not application/json (code: "unsupported_media_type")
403master:manage scope is missing
409A job type with the same code already exists

GET/v1/admin/job-types/:identifier

Get job type detail. Can be specified by UUID or job type code.

Path Parameters​

パラメータ型必須説明
identifierstring必須Job type UUID or job type code

Request Example​

Get job type
1curl https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/job-types/engineer \
2-H "Authorization: Bearer <access_token>"
Example Response (200 OK)​
JSON
{
"code": "engineer",
"name": "Engineer",
"displayOrder": 1,
"isActive": true,
"createdAt": "2025-12-24T19:26:37.000Z",
"updatedAt": "2025-12-24T19:26:37.000Z"
}

Error Responses​

StatusDescription
403master:manage scope is missing
404Job type not found

PATCH/v1/admin/job-types/:identifier

Update a job type. Only name and isActive can be updated.

Path Parameters​

パラメータ型必須説明
identifierstring必須Job type UUID or job type code

Request Body​

パラメータ型必須説明
namestring—Job type name
isActiveboolean—Active/Inactive

Request Example​

Update job type
1curl -X PATCH https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/job-types/engineer \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{"name": "Senior Engineer", "isActive": true}'
Example Response (200 OK)​
JSON
{
"code": "engineer",
"name": "Senior Engineer",
"displayOrder": 1,
"isActive": true,
"createdAt": "2025-12-24T19:26:37.000Z",
"updatedAt": "2026-04-19T02:22:55.000Z"
}

Error Responses​

StatusDescription
400Invalid request body (name exceeds 255 characters, neither name nor isActive provided, name is not a string or isActive is not a boolean, the body is malformed JSON or not a JSON object (code: "invalid_body"), etc.). Fields other than name / isActive are ignored
415The body Content-Type is not application/json (code: "unsupported_media_type")
403master:manage scope is missing
404The specified job type was not found

DELETE/v1/admin/job-types/:identifier

Delete a job type. The response structure is the same as organization deletion.

Path Parameters​

パラメータ型必須説明
identifierstring必須Job type UUID or job type code

Request Example​

Delete job type
1curl -X DELETE https://api.fd.agenticstar.tm.softbank.jp/api/v1/admin/job-types/engineer \
2-H "Authorization: Bearer <access_token>"
Example Response (200 OK)​
JSON
{ "code": "engineer", "deleted": true }

Error Responses​

StatusDescription
403master:manage scope is missing
404The specified job type was not found

Projects SaaS​

This section covers calls made with a system integration token (Client Credentials flow). For calls made with an application token (Authorization Code flow), see User API Reference (Projects).

A project is the unit in which multiple agents are placed to carry out work. From an external system you can list projects, start a run, and check run status.

There are two project types, and each is triggered differently.

TypeDescriptionHow runs are triggered
workflowAdvances through steps in order. A run starts from the first enabled step.POST /v1/projects/{projectId}/runs
cycleKeeps multiple agents running on their own schedules. An external event can add one extra ad-hoc run.POST /v1/projects/{projectId}/triggers/{triggerId}/fire
What you can operate on
The projects you can operate on are limited to the project restriction configured in Console (Console Guide — Configuring project restrictions). Specifying a project ID outside that range returns the same 404 Not Found as a project that does not exist. A system integration token can call only the five project API endpoints listed here. Calling any other project API returns 403 Forbidden (forbidden).

Endpoints​

メソッドエンドポイント説明Scope (SaaS)
GET/v1/projectsList projectsproject:read
POST/v1/projects/{projectId}/runsStart a project runproject:run
POST/v1/projects/{projectId}/triggers/{triggerId}/fireFire a trigger for one ad-hoc runproject:run
GET/v1/projects/{projectId}/runs/{runId}Get run statusproject:read
POST/v1/projects/{projectId}/runs/{runId}/cancelCancel a workflow runproject:run

GET/v1/projects

Retrieves the list of projects within the project restriction. Supports cursor-based pagination. cycle projects also appear in the list, but they are not valid targets for starting a run (POST /v1/projects/{projectId}/runs).

Query Parameters​

ParameterTypeDefaultDescription
limitinteger50Number of items to retrieve (1-100)
cursorstring—Cursor for the next page (the cursor value from the previous response)

Any other query parameter is ignored. my_role can only be used with a user token, so it is ignored if specified.

Request Example​

List projects
1curl "https://api.fd.agenticstar.tm.softbank.jp/api/v1/projects?limit=20" \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
projectsarrayArray of project objects
projects[].projectIdstringProject ID (UUID)
projects[].namestringProject name
projects[].typestring"workflow" or "cycle"
projects[].statusstringProject state. One of "active", "paused", "archived" or "admin_stopped" (stopped by an administrator)
projects[].tagsarrayArray of tags. An empty array when none are set
hasMorebooleanWhether a next page exists
cursorstringCursor for the next page. Included only when hasMore is true

Response Example​

JSON
{
"projects": [
{
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Order processing flow",
"type": "workflow",
"status": "active",
"tags": []
},
{
"projectId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"name": "Always-on inquiry handling",
"type": "cycle",
"status": "active",
"tags": []
}
],
"hasMore": false
}

Error Responses​

StatusDescription
400limit is outside 1-100 or cursor is invalid (code is invalid_parameter)
403The project:read scope is missing, or the project restriction is missing or invalid (code is insufficient_scope or invalid_project_grant)

POST/v1/projects/{projectId}/runs

Starts a run of a workflow project. Calling it for a cycle project returns 409 Conflict (unsupported_project_type).

Request Headers​

HeaderRequiredDescription
Idempotency-KeyRequiredA duplicate-run prevention key issued by the caller. 8-128 characters using alphanumerics and _ . : - only

Path Parameters​

パラメータ型必須説明
projectIdstring必須Project ID (UUID)

Request Body​

The body can be omitted. If you send one, make it a JSON object. Fields other than the one below are ignored, except that sending config returns 400 Bad Request (invalid_parameter).

パラメータ型必須説明
payloadany—The request for the run. Any JSON value (an object, an array, a string, and so on) is accepted as is. It is converted to a JSON string and attached to the request to the agent of the first step (after a fork, the first step of each lane). The agent receives it as data from outside, not as instructions. Putting a file ID in the request does not attach the file. Omitted or null means no request. Up to 8,000 characters as a JSON string

There are two limits. If payload exceeds 8,000 characters as a JSON string, 400 Bad Request (payload_too_large) is returned. If the whole body exceeds 16 KiB, 413 Payload Too Large (body_too_large) is returned.

Response Fields (201 Created / 200 OK)​

FieldTypeDescription
runIdstringRun ID (UUID). Use it to retrieve run status
existingboolean?true when an existing run was returned for a resend with the same Idempotency-Key. Not included on the first call

The first call returns 201 Created; a resend with the same Idempotency-Key returns 200 OK.

Request Example​

Start run
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/projects/3f2a9c1e-5b7d-4e8a-9c2f-1a6b4d8e0f31/runs \
2-H "Authorization: Bearer <access_token>" \
3-H "Idempotency-Key: nightly-batch-20260917" \
4-H "Content-Type: application/json" \
5-d '{
6 "payload": {
7 "ticketId": "INC-1024",
8 "summary": "Some users cannot log in"
9 }
10}'

Response Example​

JSON
{
"runId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
How Idempotency-Key is handled
  • Keys are matched per project. They do not expire.
  • Resending with the same key returns the same run even after the project has been paused, after the concurrent-run limit has been reached, or after that run has finished.
  • If a timeout leaves the outcome unknown, simply resend with the same key. Nothing is run twice.
  • To start a different run, always issue a new key.

Resending with the same key but a different payload returns 409 Conflict (origin_conflict).

Error Responses​

StatuscodeDescription
400idempotency_key_requiredThe Idempotency-Key header is missing
400idempotency_key_invalidThe Idempotency-Key length or character set is invalid
400invalid_parameterprojectId is not a UUID, or config is sent (this API does not accept it; param is config)
400payload_too_largepayload exceeds 8,000 characters as a JSON string
400invalid_bodyThe request body is malformed JSON or is not a JSON object
413body_too_largeThe request body exceeds 16 KiB
415unsupported_media_typeA request body is sent with a Content-Type other than application/json
403insufficient_scopeThe project:run scope is missing
403invalid_project_grantThe project restriction is missing or invalid
404project_not_foundThe project does not exist or is not accessible
400approvers_requiredAn enabled review step has no reviewers configured
409unsupported_project_typeA cycle project was specified
409project_inactiveThe project is not active (paused or archived)
409principal_suspendedAn administrator has suspended the user the project runs as. Ask an administrator to transfer the project to another owner, or to lift the suspension
409start_step_in_branch_laneThe start step is in a lane of a branch step. Set the start step of the time trigger to a step outside the lanes of branch steps
409definition_pendingThe first definition of the project is waiting for approval, so it cannot run yet. Start it after an approver (another owner or an administrator of the organization) approves it in the product screen
409relink_requiredThe project cannot be started or resumed until the references that were not found during import are reconnected. The remaining references appear in the project's relink and in the placements' relink. To clear the references that refuse a start: for rows whose kind is "agent", place the agent again (POST /v1/projects/{projectId}/placements); for rows whose kind is "connector", save the connector again on the product screen; for the placements' relink (playbooks and skills that the placed agent points to but were not found), save the agent again with a spec (PATCH /v1/agents/{agentId}; an update that does not send spec does not clear them). Rows whose blocking is false are items to set up again if needed and do not refuse runs; they can be cleared with DELETE /v1/projects/{projectId}/relink, but clearing them alone does not make the project startable
409branch_ai_unavailableBranch steps that ask AI cannot run in this environment. Ask an administrator to set up the AI decision for branch steps, or disable those steps in the product screen, then start a new run
409automation_dlp_enabledExternal automation steps cannot be saved or run while DLP integration is on. Ask an administrator to turn off DLP integration. Until then, a run can start only after the external automation steps are disabled or removed
409automation_destination_missingThe destination of the external automation step was not found. Set automationConfig.destinationId to an active destination from GET /v1/projects/automation-destinations with the API that updates the step, or disable the step. If no destinations are listed, ask an administrator
409automation_destination_inactiveThe destination of the external automation step is inactive. Ask an administrator to activate the destination, set automationConfig.destinationId to another active destination from GET /v1/projects/automation-destinations with the API that updates the step, or disable the step
409admin_stoppedAn administrator has stopped the project. Ask an administrator to resume it (this API cannot resume it)
409unsupported_runtimeThe project cannot run in this configuration, for example because agent runtimes are mixed
409origin_conflictA different payload was sent with the same Idempotency-Key
429too_many_active_runsThe project already has the maximum number of runs (3 in total) that are running or awaiting review

POST/v1/projects/{projectId}/triggers/{triggerId}/fire

Fires a webhook trigger configured on a cycle project and runs the target agent once, as an extra ad-hoc run. Calling it for a workflow project returns 404 Not Found.

The scheduled runs stay exactly as configured. A fired run is added separately from the schedule. Where an earlier fire has not started running yet, however, a later fire may be merged into that run. Where it is, jobId returns the same value as the earlier fire, so the number of fires and the number of runs do not necessarily match.

Path Parameters​

パラメータ型必須説明
projectIdstring必須Project ID (UUID)
triggerIdstring必須ID of the trigger to fire (UUID)

Request Body​

パラメータ型必須説明
eventIdstring必須A unique ID issued by the sender. Resending the same ID is treated as a duplicate. 1-160 characters using alphanumerics and _ . : @ + - only
payloadany—Arbitrary JSON passed to the agent. It is serialized to a JSON string and added to the request sent to the agent; anything beyond 8,000 characters after serialization is omitted

Request Example​

Fire trigger
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/projects/3f2a9c1e-5b7d-4e8a-9c2f-1a6b4d8e0f31/triggers/d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70/fire \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{
5 "eventId": "order-20261118-0001",
6 "payload": {
7 "orderId": "A-1024"
8 }
9}'

Response Fields (202 Accepted)​

FieldTypeDescription
resultstring"accepted" (newly accepted) or "duplicate" (already accepted for the same eventId)
jobIdstringID of the receiving job. It cannot be used to get run status (GET /v1/projects/{projectId}/runs/{runId})

Response Example​

JSON
{
"result": "accepted",
"jobId": "9b2e4c61-0f3a-4a9b-9c1d-2f7e5a8b3c40"
}
What 202 means here

This 202 Accepted means only that the request was recorded as accepted. The run happens afterwards, and its outcome is not part of this response. Do not treat 202 as business success.

Resending​

Idempotency is decided by the combination of project, trigger, and eventId. Resending the same content returns 202 with result: "duplicate". Sending the same eventId with a different payload returns 409 Conflict (event_conflict).

Error Responses​

StatuscodeDescription
400invalid_event_ideventId is missing or has an invalid format
400invalid_parameterprojectId or triggerId is not a UUID
400invalid_bodyThe request body is malformed JSON or is not a JSON object
415unsupported_media_typeA request body is sent with a Content-Type other than application/json
403insufficient_scopeThe project:run scope is missing
403invalid_project_grantThe project restriction is missing or invalid
404trigger_not_foundThe project or trigger does not exist, is not accessible, the trigger is not a webhook trigger, or a workflow project was specified
409trigger_disabledThe trigger is disabled
409project_not_activeThe project is not in a runnable state
409principal_suspendedAn administrator has suspended the user the project runs as. Ask an administrator to transfer the project to another owner, or to lift the suspension
409admin_stoppedAn administrator has stopped the project, or the Agent of the placement the trigger runs. Ask an administrator to resume it
409placement_unavailableThe target agent placement does not exist, no execution principal is configured, or the step of the placement is disabled (only a project owner can enable the step; enable it, then retry)
409event_conflictThe same eventId was sent with a different payload
413body_too_largeThe request body exceeds 16 KiB

GET/v1/projects/{projectId}/runs/{runId}

Retrieves the status of a run. Besides runs started through the API (POST /v1/projects/{projectId}/runs), runs started from the UI, by email, or on a schedule can also be retrieved. cycle projects do not create runs, so they are out of scope for this endpoint.

Path Parameters​

パラメータ型必須説明
projectIdstring必須Project ID (UUID)
runIdstring必須Run ID (UUID)

Request Example​

Get run
1curl https://api.fd.agenticstar.tm.softbank.jp/api/v1/projects/3f2a9c1e-5b7d-4e8a-9c2f-1a6b4d8e0f31/runs/7c1d5e2a-8f3b-4a6c-b9d0-2e4f6a8c0b13 \
2-H "Authorization: Bearer <access_token>"

Response Fields (200 OK)​

FieldTypeDescription
runIdstringRun ID (UUID)
statusstringRun state. One of "running" (running), "waiting_gate" (awaiting review), "closed_done" (completed), "closed_rejected" (ended by rejection), "closed_failed" (ended by failure) or "cancelled" (cancelled). Any value other than "running" and "waiting_gate" means the run has ended. However, when an owner or operator (including people with the organization operations role) resumes a "closed_rejected" or "closed_failed" run, the same run returns to "running" (endedAt also returns to null)
originTypestring | nullHow the run started. One of "manual" (started from the UI), "api" (started through the API), "mail" (started by email) or "cron" (scheduled)
originRefstring | nullA reference value that depends on how the run started. For a run started through the API, the Idempotency-Key used to start it
currentStepIdstring | nullID (UUID) of the step in progress. While the run proceeds in separate lanes, the ID of the step before the branch. null for a completed run. For a run that ended for another reason, the ID of the step at that time may remain
startedByRefstring | nullWho or what started the run. See the "Who started the run" table below
actorLabelstring | nullDisplay name of a starter that is not a user (the system integration name or the sender address of an email). null otherwise
startedAtstring | nullStart time (ISO 8601). null before it starts
endedAtstring | nullEnd time (ISO 8601). null before it ends. It returns to null when a closed run is resumed
summarystring | nullFor a completed run, the output of the last completed step that recorded an output (first 2,000 characters). null if there is no such step and for a run that has not completed
runtimeKindstring | nullKind of runtime ("autonomous"). May be null for older runs
cancelRequestedAtstring | nullTime (ISO 8601) when cancellation was requested. null if not requested
deadlineAtstring | nullDeadline of the workflow run (ISO 8601). null if it has no deadline
configRevisionnumber | nullRevision of the case configuration (Marketplace edition runs only). null for SaaS runs
stepsarrayRecords of the step runs, in the order they were recorded
steps[].runStepIdstringID of the step run (starts with "rs:")
steps[].stepIdstring | nullStep ID (UUID)
steps[].placementIdstring | nullID (UUID) of the placement that handled the step. null for rows that do not run an agent (such as review steps)
steps[].executionIdstring | nullID of the agent execution. Set once the agent starts running. null for an external automation step
steps[].conversationIdstring | nullID of the conversation of the agent execution. Set once the agent starts running
steps[].statusstringOne of "pending" (waiting to run), "running" (running), "waiting_gate" (awaiting review), "done" (done), "failed" (failed) or "skipped" (skipped)
steps[].attemptnumber | nullRetry count within the same visit (starting at 1). It also increases when a closed run is resumed and when the Agent is relaunched after a connection confirmation is approved
steps[].lanestring | nullID of the lane the step belongs to. "main" for steps that are not in a separate lane
steps[].scheduledAtstring | nullWhen the step has a scheduled time, the time (ISO 8601) this row waits for. null once it starts
steps[].startedAtstring | nullStart time (ISO 8601)
steps[].endedAtstring | nullEnd time (ISO 8601)
steps[].outputSummarystring | nullSummary of the step output
steps[].outcomestring | nullResult of the agent execution or of the send of an external automation step. One of "completed", "incomplete", "failed", "timeout", "stopped", "denied" or "skipped". null for rows without a result
steps[].reasonCodestring | nullReason code for the result. "branch_undecided" when a branch could not decide and a person is asked to choose; "branch_not_selected" for a step in a lane the branch did not choose
steps[].heldbooleanWhether the step is held because the project is paused and is waiting to resume
steps[].visitnumber | nullWhich visit to this step this is (increases with send-backs). null for rows without this record
steps[].reworkReasonstring | nullReason for the send-back
steps[].gateForstring | nullFor a review row, the step run (runStepId) it was raised for
steps[].routedFromstring | nullWhen steps were skipped by choosing a destination, the step run (runStepId) that chose it
steps[].latestring | nullWhy a result that arrived late was not used to advance the run
steps[].gateobject | nullSummary of the review. Set on review step rows and on connection confirmation wait rows (gateKind is "connection"). null for other rows
steps[].gate.decisionstring | nullOne of "proceed", "send_back" or "reject". null if not decided yet
steps[].gate.waitSourcestring | nullWhat the review waits for. "human" (a person's decision) or "external" (an external condition)
steps[].resumeCommandIdstring | nullThe commandId used when this row was started by resuming a closed run. It is set on the rows started by that resume (the step chosen and the other lanes started again). Otherwise null
steps[].resumeReasonstring | nullThe reason for resuming a closed run. It is set on the same rows as resumeCommandId. Otherwise null
steps[].supersededBystring | null"resume" when a row left over from the previous round was closed by resuming a closed run. Otherwise null
steps[].gateKindstring | null"connection" for a connection confirmation wait row (a row created when the Agent stops before using a connector that requires human confirmation). null otherwise
steps[].connectionConfirmOfstring | nullFor a row relaunched after a connection confirmation is approved, the ID of that work item (workItemId). null otherwise
steps[].handoffobject | nullThe values and files this step's execution passed to the next step. null when the step has no values and file roles for the next step (outputConfig)
steps[].handoff.valuesobjectValue name → the returned text (up to 1,000 characters each)
steps[].handoff.filesobjectRole name → { filename } (the file name of the file with that role)
steps[].handoff.missing[]object[]What did not arrive: name (the value or role name) and reason ("not_returned" (the agent did not return it) / "file_not_found" (not among the output files))
steps[].handoff.truncatedstring[]Names of values cut at 1,000 characters. [] when none
plannedPlacementsarrayOrder of steps and placements planned to run, based on the configuration when the run started
plannedPlacements[].stepIdstring | nullStep ID (UUID)
plannedPlacements[].placementIdstring | nullPlacement ID (UUID). null for review steps and steps without an agent
lanesarrayStatus of each lane after the branch. An empty array before the branch and for runs that do not use lanes
lanes[].laneIdstringLane ID
lanes[].namestring | nullLane name
lanes[].positionnumber | nullLane order (starting at 1)
lanes[].statestringOne of "running" (running), "waiting_gate" (awaiting review), "arrived" (waiting to join) or "closed" (ended)
lanes[].currentStepIdstring | nullID (UUID) of the step in progress in that lane. null for a lane waiting to join. For a lane that has ended, the ID of its last step may remain
lanes[].arrivedbooleanWhether the lane has reached the join point

The fields are the same regardless of the token used for the call (an application or a system integration).

Who started the run​
Started bystartedByRefactorLabel
A user (from the UI, through the API, or by email sent from a member address)User IDnull
A system integration"client:" followed by the Client ID of the system integration. "system:federation-api" if the Client ID is unknownName of the system integration (null if unknown)
Email sent from an address that is not a member"mail:" followed by a hash of the senderSender address
A schedulenullnull

For runs started by a system integration before 2026-09-25, startedByRef is null.

Response Example​

JSON
{
"runId": "7c1d5e2a-8f3b-4a6c-b9d0-2e4f6a8c0b13",
"status": "running",
"originType": "api",
"originRef": "nightly-batch-20260917",
"currentStepId": "5d6e7f80-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
"startedByRef": "bbbe4306-6975-420b-af47-fb4c8f48b4aa",
"actorLabel": null,
"startedAt": "2026-09-17T01:30:00.000Z",
"endedAt": null,
"summary": null,
"runtimeKind": "autonomous",
"cancelRequestedAt": null,
"deadlineAt": null,
"configRevision": null,
"steps": [
{
"runStepId": "rs:1042",
"stepId": "5d6e7f80-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
"placementId": "e4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8",
"executionId": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
"conversationId": "9c8b7a6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"status": "running",
"attempt": 1,
"lane": "main",
"scheduledAt": null,
"startedAt": "2026-09-17T01:30:01.000Z",
"endedAt": null,
"outputSummary": null,
"outcome": null,
"reasonCode": null,
"held": false,
"visit": 1,
"reworkReason": null,
"gateFor": null,
"routedFrom": null,
"late": null,
"gate": null,
"resumeCommandId": null,
"resumeReason": null,
"supersededBy": null,
"gateKind": null,
"connectionConfirmOf": null,
"handoff": null
}
],
"plannedPlacements": [
{ "stepId": "5d6e7f80-1a2b-4c3d-8e9f-0a1b2c3d4e5f", "placementId": "e4f5a6b7-c8d9-4e0f-a1b2-c3d4e5f6a7b8" },
{ "stepId": "c2f1a8e4-6b3d-4e7a-9c15-8d2e4f6a7b90", "placementId": null }
],
"lanes": []
}

Error Responses​

StatuscodeDescription
400invalid_parameterprojectId or runId is not a UUID
403insufficient_scopeThe project:read scope is missing
403invalid_project_grantThe project restriction is missing or invalid
404run_not_foundThe run does not exist, belongs to another project, or is not accessible

POST/v1/projects/{projectId}/runs/{runId}/cancel

Cancels a workflow run that is running or awaiting review (status is "running" or "waiting_gate"). This is the same as Cancel run on the screen.

When it is cancelled:

  • The status of the workflow run becomes "cancelled" (cancelled). This cannot be undone, and the workflow run cannot be resumed (only workflow runs closed by a rejection or a failure can be resumed).
  • Steps in progress are marked failed, and running Agents are told to stop.
  • Review requests of review steps that have not been decided are withdrawn.

Path Parameters​

パラメータ型必須説明
projectIdstring必須Project ID (UUID)
runIdstring必須ID of the workflow run (UUID)

Request Body​

FieldTypeRequiredDescription
commandIdstringYesA value to identify resends (8 to 128 characters of letters, digits, and _ . : -)
reasonstring—The reason for canceling (up to 500 characters)
  • If you send it for a workflow run that is not running (after it ended or was cancelled), nothing changes: 200 OK is returned with existing set to true. The same applies when you resend after it was cancelled.
  • If you send it around the same time as another cancel or the end of the workflow run, the choice between 202 Accepted and 200 OK and the value of existing may not match what actually happened. Check the result with status of Get a Workflow Run (GET /v1/projects/{projectId}/runs/{runId}).
  • 504 Gateway Timeout does not mean "it was not cancelled". Resend with the same commandId, or check status with Get a Workflow Run.

Request Example​

Cancel run
1curl -X POST https://api.fd.agenticstar.tm.softbank.jp/api/v1/projects/3f2a9c1e-5b7d-4e8a-9c2f-1a6b4d8e0f31/runs/7c1d5e2a-8f3b-4a6c-b9d0-2e4f6a8c0b13/cancel \
2-H "Authorization: Bearer <access_token>" \
3-H "Content-Type: application/json" \
4-d '{
5 "commandId": "cancel-20261118-0001",
6 "reason": "Because an error in the input data was noticed"
7}'

Response Fields (202 Accepted / 200 OK)​

202 Accepted when this request cancelled the workflow run, and 200 OK when it did not.

FieldTypeDescription
runIdstringID of the workflow run
statusstringThe status of the workflow run after the request ("cancelled" when it was cancelled)
cancelRequestedAtstring | nullWhen the cancel was accepted (ISO 8601). null for a workflow run that was not cancelled
existingbooleantrue when this request did not newly cancel the workflow run (always false with 202 Accepted)

Response Example​

JSON
{
"runId": "7c1d5e2a-8f3b-4a6c-b9d0-2e4f6a8c0b13",
"status": "cancelled",
"cancelRequestedAt": "2026-11-18T05:12:30.000Z",
"existing": false
}

Error Responses​

StatuscodeDescription
400invalid_parameterprojectId or runId is not a UUID, commandId is missing or has the wrong form, or reason is not a string or is longer than 500 characters
400invalid_bodyThe body is malformed JSON or not a JSON object
403insufficient_scopeThe project:run scope is missing
403invalid_project_grantThe project restriction is missing or invalid
404run_not_foundThe workflow run does not exist, belongs to another project, or the project is not accessible
413body_too_largeThe body exceeds 16 KiB
415unsupported_media_typeThe Content-Type of the body is not application/json

Notes on the Project API​

ItemDetail
What 404 meansThe same 404 Not Found is returned whether the project does not exist or is not accessible, and the response does not reveal which of the two applies. The code is fixed per endpoint: project_not_found for starting a run, trigger_not_found for firing a trigger, and run_not_found for run status and for canceling a workflow run.
When the type is out of scopeCalling trigger fire on a workflow project, or run status or canceling a workflow run on a cycle project, returns 404. Starting a run on a cycle project is the one exception: it returns 409 unsupported_project_type.
Request bodyWhen you send a body, make it a JSON object. Anything other than Content-Type: application/json returns 415, malformed JSON or a body that is not a JSON object returns 400 (invalid_body), and a body larger than 16 KiB returns 413.
Unknown fields / queriesFields and query parameters that are not in the specification are ignored. An invalid value for a documented query parameter, or a cursor that cannot be read, returns 400 Bad Request.
Timeouts504 Gateway Timeout does not mean "it did not run". Resend a run start with the same Idempotency-Key, a trigger fire with the same eventId and the same body, and a workflow run cancel with the same commandId.

Error Responses​

HTTP Status Codes​

HTTP status codes that may be returned by any endpoint.

StatusDescription
400 Bad RequestInvalid request parameters
401 UnauthorizedInvalid or missing token
403 ForbiddenInsufficient permissions to access the resource
404 Not FoundResource not found
409 ConflictResource conflict (e.g., duplicate code)
413 Payload Too LargeRequest body exceeds the size limit
415 Unsupported Media TypeThe request body format (Content-Type) is not supported
429 Too Many RequestsRate limit exceeded
500 Internal Server ErrorInternal server error
502 Bad GatewayCommunication error with an upstream service
503 Service UnavailableService temporarily unavailable
504 Gateway TimeoutUpstream service response timeout

Error Response Format​

All error responses are returned with the following common structure.

FieldTypeDescription
error.typestringError category. One of "invalid_request_error", "authentication_error", "insufficient_scope_error", "forbidden_error", "not_found_error", "conflict_error", "payload_too_large_error", "rate_limit_error", "server_error", or "upstream_error"
error.messagestringHuman-readable error message
error.codestringMachine-processable error code (e.g., "missing_parameter", "invalid_parameter", "invalid_token")
error.paramstringThe parameter name that caused the error. Included only for validation errors
error.suggested_actionstringRecommended action to resolve the error. Included only for some errors
JSON
{
"error": {
"type": "invalid_request_error",
"message": "Invalid parameter: limit",
"code": "invalid_parameter",
"param": "limit",
"suggested_action": "limit must be between 1 and 100"
}
}

When the Request Is Stopped Before Reaching the API​

If a layer in front of the API (such as a security inspection) returns an HTML error page, the response is replaced with JSON in the common format above. In that case, error.code is one of the following.

Statuserror.codeDescription
403waf_blockedThe request was stopped by a security inspection in front of the API. If the request is legitimate, contact support with error.reference (or the x-request-id response header if it is not present)
4xx and 5xx other than 403upstream_api_errorThe request was rejected by, or caused an error in, a layer in front of the API. If this continues, contact support with error.reference (or the x-request-id response header if it is not present)
FieldTypeDescription
error.referencestringReference number for a request stopped before reaching the API. Include it when contacting support. Omitted when no value is available
JSON
{
"error": {
"type": "forbidden_error",
"message": "The request was blocked by a web application firewall before it reached the API.",
"code": "waf_blocked",
"suggested_action": "The request matched a firewall rule in front of the API. If the request is legitimate, contact support with the reference.",
"reference": "20261018T012345Z-0123456789abcdef"
}
}

Automatically Recorded Management Operations SaaS​

The following management operations automatically generate an audit log entry.

ResourceOperationaction
UserCreatecreate
UserChange role (promote to admin)promote
UserChange role (demote to general)demote
UserApproveapprove
UserRevoke approvalreject
UserDeletedelete
OrganizationCreatecreate
OrganizationUpdateupdate
OrganizationDeletedelete
Job typeCreatecreate
Job typeUpdateupdate
Job typeDeletedelete
UserSuspend, resume, and unlock (meta.action is suspend, resume, or unlock)update
UserChange affiliation and job (meta.action is update-affiliation)update