Call a source (explicit form)

curl --request POST \
  --url https://gateway.apiosk.com/v2/sources/{source_id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operation": "company_registry.search"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({operation: 'company_registry.search'})
};

fetch('https://gateway.apiosk.com/v2/sources/{source_id}/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "requires_approval",
  "question": "<string>",
  "plan": {
    "quote_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expires_at": "2023-11-07T05:31:56Z",
    "steps": [
      {
        "source_id": "kvk-dutch-business-register",
        "operation": "company_registry.search",
        "name": "<string>",
        "conditional": true,
        "estimated_cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "estimated_total": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "answer": {},
  "data": {},
  "results": [
    {
      "result_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": {
        "provider": "<string>",
        "name": "<string>"
      },
      "data": {}
    }
  ],
  "usage": {
    "sources": [
      {
        "source_id": "<string>",
        "operation": "<string>",
        "calls": 123,
        "cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "cost": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "held": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "balance": {
    "remaining": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "retry_after_ms": 123,
  "message": "<string>",
  "needs_input": [
    {
      "label": "<string>",
      "schema": {}
    }
  ],
  "candidates": [
    {}
  ],
  "approval_required_reason": {
    "code": "<string>",
    "message": "<string>"
  },
  "metadata": {},
  "continuation": {
    "state": {
      "schema_version": "2",
      "state_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision": 1,
      "expires_at": "2023-11-07T05:31:56Z",
      "focus": {
        "entity_refs": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "goal_refs": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      },
      "state_token": "<string>"
    },
    "actions": [
      {
        "action_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "select_entity",
        "label": "<string>",
        "requires_authorization": false,
        "input_schema": {}
      }
    ]
  }
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "requires_approval",
  "question": "<string>",
  "plan": {
    "quote_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expires_at": "2023-11-07T05:31:56Z",
    "steps": [
      {
        "source_id": "kvk-dutch-business-register",
        "operation": "company_registry.search",
        "name": "<string>",
        "conditional": true,
        "estimated_cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "estimated_total": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "answer": {},
  "data": {},
  "results": [
    {
      "result_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": {
        "provider": "<string>",
        "name": "<string>"
      },
      "data": {}
    }
  ],
  "usage": {
    "sources": [
      {
        "source_id": "<string>",
        "operation": "<string>",
        "calls": 123,
        "cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "cost": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "held": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "balance": {
    "remaining": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "retry_after_ms": 123,
  "message": "<string>",
  "needs_input": [
    {
      "label": "<string>",
      "schema": {}
    }
  ],
  "candidates": [
    {}
  ],
  "approval_required_reason": {
    "code": "<string>",
    "message": "<string>"
  },
  "metadata": {},
  "continuation": {
    "state": {
      "schema_version": "2",
      "state_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision": 1,
      "expires_at": "2023-11-07T05:31:56Z",
      "focus": {
        "entity_refs": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "goal_refs": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      },
      "state_token": "<string>"
    },
    "actions": [
      {
        "action_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "select_entity",
        "label": "<string>",
        "requires_authorization": false,
        "input_schema": {}
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

POST

sources

{source_id}

run

Call a source (explicit form)

curl --request POST \
  --url https://gateway.apiosk.com/v2/sources/{source_id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operation": "company_registry.search"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({operation: 'company_registry.search'})
};

fetch('https://gateway.apiosk.com/v2/sources/{source_id}/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "requires_approval",
  "question": "<string>",
  "plan": {
    "quote_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expires_at": "2023-11-07T05:31:56Z",
    "steps": [
      {
        "source_id": "kvk-dutch-business-register",
        "operation": "company_registry.search",
        "name": "<string>",
        "conditional": true,
        "estimated_cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "estimated_total": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "answer": {},
  "data": {},
  "results": [
    {
      "result_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": {
        "provider": "<string>",
        "name": "<string>"
      },
      "data": {}
    }
  ],
  "usage": {
    "sources": [
      {
        "source_id": "<string>",
        "operation": "<string>",
        "calls": 123,
        "cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "cost": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "held": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "balance": {
    "remaining": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "retry_after_ms": 123,
  "message": "<string>",
  "needs_input": [
    {
      "label": "<string>",
      "schema": {}
    }
  ],
  "candidates": [
    {}
  ],
  "approval_required_reason": {
    "code": "<string>",
    "message": "<string>"
  },
  "metadata": {},
  "continuation": {
    "state": {
      "schema_version": "2",
      "state_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision": 1,
      "expires_at": "2023-11-07T05:31:56Z",
      "focus": {
        "entity_refs": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "goal_refs": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      },
      "state_token": "<string>"
    },
    "actions": [
      {
        "action_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "select_entity",
        "label": "<string>",
        "requires_authorization": false,
        "input_schema": {}
      }
    ]
  }
}

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "requires_approval",
  "question": "<string>",
  "plan": {
    "quote_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expires_at": "2023-11-07T05:31:56Z",
    "steps": [
      {
        "source_id": "kvk-dutch-business-register",
        "operation": "company_registry.search",
        "name": "<string>",
        "conditional": true,
        "estimated_cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "estimated_total": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "answer": {},
  "data": {},
  "results": [
    {
      "result_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": {
        "provider": "<string>",
        "name": "<string>"
      },
      "data": {}
    }
  ],
  "usage": {
    "sources": [
      {
        "source_id": "<string>",
        "operation": "<string>",
        "calls": 123,
        "cost": {
          "amount": 0.023,
          "amount_micro_usd": "23000",
          "currency": "USD"
        }
      }
    ],
    "cost": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "held": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "balance": {
    "remaining": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    }
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "retry_after_ms": 123,
  "message": "<string>",
  "needs_input": [
    {
      "label": "<string>",
      "schema": {}
    }
  ],
  "candidates": [
    {}
  ],
  "approval_required_reason": {
    "code": "<string>",
    "message": "<string>"
  },
  "metadata": {},
  "continuation": {
    "state": {
      "schema_version": "2",
      "state_ref": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision": 1,
      "expires_at": "2023-11-07T05:31:56Z",
      "focus": {
        "entity_refs": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "goal_refs": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      },
      "state_token": "<string>"
    },
    "actions": [
      {
        "action_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "select_entity",
        "label": "<string>",
        "requires_authorization": false,
        "input_schema": {}
      }
    ]
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

{
  "error": {
    "code": "invalid_source_input",
    "message": "<string>",
    "required_scope": "<string>",
    "limit": "per_request",
    "required": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "available": {
      "amount": 0.023,
      "amount_micro_usd": "23000",
      "currency": "USD"
    },
    "field": "<string>",
    "missing": [
      "<string>"
    ],
    "expected": [
      "<string>"
    ],
    "operations": [
      "<string>"
    ],
    "retry_after_ms": 123
  }
}

Authorizations

Authorization

string

header

required

An organisation API key: Authorization: Bearer apk_org_live_…

Headers

Idempotency-Key

string

Retry-safe key: the same key with the same body pays once.

Maximum string length: 255

Path Parameters

source_id

string

required

Body

application/json

operation

string

required

Example:

"company_registry.search"

input

object

Example:

{ "company.name": "Mollie B.V." }

max_spend

number

Example:

1

wait_seconds

integer

Required range: 0 <= x <= 55

Response

Success

string<uuid>

status

enum<string>

Available options:

requires_approval,

running,

completed,

partial,

needs_input,

needs_selection,

unsupported,

cancelled,

failed

question

string

plan

object

Show child attributes

answer

object | null

Apiosk's reading of the results, with evidence pointers. Null for a direct call.

data

object

The source document, when the run produced exactly one.

results

object[]

Show child attributes

usage

object

Show child attributes

balance

object

Show child attributes

errors

object[]

Show child attributes

retry_after_ms

integer

message

string | null

Natural-language clarification for needs_input.

needs_input

object[]

Show child attributes

candidates

object[] | null

approval_required_reason

object

Show child attributes

metadata

object

Attribution for a single result, when present.

continuation

object

Show child attributes

Buy data

Use cases

Operating it

API Reference

Ask

Call a source (explicit form)

Authorizations

Headers

Path Parameters

Body

Response