• AI reference · Area connections

connector_read

Read from a connected service. Read from a connected service with the company's own connection. To change something there, use connector_call. In the free trial, the company's own connected services can be called up to 1,000 times in any 24 hours (built-in services don't count); paid plans have no daily limit. The address must be a public https address.

Where it is

In the connections area (connected services, secrets and the company's language): open it with tools_for { area: "connections" }, then call it with read_tool { name: "connector_read", args }.

Does it need a yes?

Reads only: it changes nothing. Here: a read-only call.

Inputs

InputTypeNeededAbout
namestringyesThe connector's name, from connectors. · 1 to 60 characters
toolstringyesOne of its tools that only reads, from connector_tools. · 1 to 100 characters
argsobjectnoThe tool's input.
request_keystringyesOne key per read: the same key again returns the same result. · format `^[A-Za-z0-9][A-Za-z0-9:._-]{0,99}$`
run_idstringnoThe run_id from start. Pass it on every call: it keeps your task held. · 1 to 100 characters

Example

{
  "name": "connector_read",
  "arguments": {
    "name": "name",
    "tool": "tool",
    "request_key": "request key"
  }
}

When it is refused

  • invalid: The input isn't right. The sentence names the field and the fix; nothing was done. Fix it and call again.
  • not_found: No such thing in this company (a task, file, person, record). Check the number or name, or list first.
  • not_allowed: Not without another step: the owner's yes, your own task held with pick_up, or a setting the owner turns on. The sentence says which.
  • taken: Someone else holds it (another AI on that task). Pick another task.
  • stale: It changed since you read it. Read it again and use the new version.
  • failed: On our side or a service's, never your input. Try again in a minute; if it keeps failing, call report_problem.