Skip to content

More of a long result

GET
/results/more
curl 'https://api.xholic.ai/v1/results/more?resultId=%3CresultId%3E' \
-H "Authorization: Bearer $XHOLIC_API_KEY"

The rest of a result too big for one reply. When a result has partial, part 1 is what you got: call this with partial.next.input for part 2, then each part’s next, until next is null. Each later part’s segments add items to a list, or text to a string, at a path in part 1 (partial.continued lists them). With section and a plan_my_day resultId, returns one section the plan trimmed, in full. Results are kept for 30 minutes; after that, run the original tool again. Free.

resultId
required

Partial.resultId from the result, or the resultId in a getRest pointer.

string
/^r_[A-Za-z0-9_-]{8,64}$/

Partial.resultId from the result, or the resultId in a getRest pointer.

Example

<resultId>
part

Which part, from 1. Leave out for part 2.

integer
>= 1 <= 1000

Which part, from 1. Leave out for part 2.

section

A section name from a getRest pointer, to get that section in full.

string
>= 1 characters <= 80 characters

A section name from a getRest pointer, to get that section in full.

account

X account to act on, as @handle. Leave it out to use the connection’s default account.

string
>= 1 characters <= 64 characters

X account to act on, as @handle. Leave it out to use the connection’s default account.

Success

Media typeapplication/json
object
ok
required
boolean
summary
required

One or two readable sentences about the result.

string
data
required

The result. Its shape depends on the action.

ids
object
key
additional properties
any
next
Array<string>
creditsCharged
number
dryRun
boolean

Example

{
"ok": true
}

Error

Media typeapplication/json
object
ok
required
boolean
error
required
object
code
required
string
Allowed values: UNAUTHENTICATED INVALID_CREDENTIAL SCOPE_MISSING ROLE_NOT_PERMITTED ACCOUNT_NOT_FOUND SUBSCRIPTION_REQUIRED FEATURE_NOT_INCLUDED APP_ONLY INVALID_INPUT NOT_FOUND CONFLICT CREDITS_CONFIRMATION_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED IDEMPOTENCY_KEY_REUSED IDEMPOTENCY_IN_PROGRESS X_DATA_LIMIT_REACHED ACCOUNT_ON_HOLD UPSTREAM_UNAVAILABLE MAINTENANCE INCIDENT INTERNAL_ERROR
message
required
string
scope
required
string
Allowed values: account platform
retryAfterSeconds
integer
details

Example

{
"ok": false,
"error": {
"code": "UNAUTHENTICATED",
"scope": "account"
}
}