resources

Update a resource

Changes its title, its tags, or, for a text resource, its text. A new text, or a new title on a file, is re-indexed; the resource stays searchable on its current version meanwhile.

PATCH/v1/resources/{resource_id}

Request

curl --request PATCH \
  --url 'https://api.lookio.app/v1/resources/<resource_id>' \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "<string>",
  "tags": [
    "<string>"
  ],
  "text": "<string>",
  "source": "<string>"
}'

import json
import requests

url = "https://api.lookio.app/v1/resources/<resource_id>"
headers = {
  "Authorization": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"title\":\"<string>\",\"tags\":[\"<string>\"],\"text\":\"<string>\",\"source\":\"<string>\"}")

response = requests.request("PATCH", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://api.lookio.app/v1/resources/<resource_id>", {
  method: "PATCH",
  headers: {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "title": "<string>",
    "tags": [
      "<string>"
    ],
    "text": "<string>",
    "source": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.lookio.app/v1/resources/<resource_id>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"title\":\"<string>\",\"tags\":[\"<string>\"],\"text\":\"<string>\",\"source\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("PATCH", "https://api.lookio.app/v1/resources/<resource_id>", bytes.NewBuffer([]byte("{\"title\":\"<string>\",\"tags\":[\"<string>\"],\"text\":\"<string>\",\"source\":\"<string>\"}")))
  req.Header.Set("Authorization", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.lookio.app/v1/resources/<resource_id>"))
    .header("Authorization", "<api-key>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"title\":\"<string>\",\"tags\":[\"<string>\"],\"text\":\"<string>\",\"source\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.lookio.app/v1/resources/<resource_id>")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"title\":\"<string>\",\"tags\":[\"<string>\"],\"text\":\"<string>\",\"source\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "res_thk6smb5nvts",
    "title": "Refund policy",
    "type": "text",
    "status": "ready",
    "status_detail": null,
    "tags": [
      "legal",
      "faq"
    ],
    "source_url": null,
    "source": "Employee handbook, 2026 edition",
    "site": null,
    "created_at": "2026-10-12T09:30:00.000Z",
    "updated_at": "2026-10-12T09:30:00.000Z"
  },
  "request_id": "req_01K9X7M2Q4"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

Requires resources:write.

Send at least one of title, tags, text or source.

tags replaces the whole list. An empty list clears the tags.
text is only for text resources. On any other type it fails with invalid_parameter.
source is shown with every citation of the resource. An empty string clears it.

A new text, or a new title, is indexed again because the title is part of every passage. The resource stays searchable on its current version until the new one is ready.

A PATCH is not retried by the CLI after a server error. Read the resource before you try again.

Authorizations

Authorizationbearerin headerrequired

Path parameters

resource_idstringrequiredpattern: ^res_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

Body

application/jsonrequired

titlestringlength: 1–200 chars

tagsstring[]items: ≤ 30 items

Up to 30 tags of 60 characters. An assistant can follow a tag to use every resource carrying it.

textstringlength: 1–100000 chars

Text resources only: the new text, which is re-indexed.

sourcestringlength: ≤ 500 chars

Where this resource comes from, shown with every citation of it: a URL or a mention such as "Employee handbook, 2026 edition". Up to 500 characters; an empty string clears it.

Response

application/json

Update a resource

dataobjectrequired

Show child attributes

data.idstringrequiredpattern: ^res_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

data.titlestringrequired

data.typeenum<string>requiredone of: text, file, url, site

data.statusenum<string>requiredone of: queued, processing, ready, failed, stale, ready_simulated

queued and processing: being read and indexed (pass wait=true or poll until it changes). ready: searchable. failed: see status_detail, then fix and call reindex.

data.status_detailstringnullrequired

data.tagsstring[]required

data.source_urlstringnullrequired

The page or site address, for url and site resources.

data.sourcestringnullrequired

Where it comes from, as shown with its citations.

data.siteobject | nullrequired

A site's page rules and schedule; null for other types.

Show child attributes

data.site.rulesobjectrequireddefault: {"include":[],"exclude":[],"excluded_urls":[]}

Show child attributes

data.site.rules.includestring[]requireddefault: []items: ≤ 50 items

Path patterns to keep, such as /docs/**. * is one level, ** everything below. Empty keeps the whole site.

data.site.rules.excludestring[]requireddefault: []items: ≤ 50 items

Path patterns to leave out, such as /blog/**.

data.site.rules.regexstringlength: ≤ 500 chars

Advanced: a regular expression on the path; matching pages are left out.

data.site.rules.excluded_urlsstring[]requireddefault: []items: ≤ 5000 items

Single pages to leave out, by full address.

manual syncs only on request. Recurring schedules accept daily, weekly, monthly, or every_N_days, every_N_weeks and every_N_months (1-90 days, 1-52 weeks, 1-12 months). Recurring schedules require a paid plan.

data.site.last_synced_atstringnullrequired

data.created_atstringrequired

data.updated_atstringrequired

request_idstringrequired

curl --request PATCH \ --url 'https://api.lookio.app/v1/resources/<resource_id>' \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "title": "<string>", "tags": [ "<string>" ], "text": "<string>", "source": "<string>" }'

{ "data": { "id": "res_thk6smb5nvts", "title": "Refund policy", "type": "text", "status": "ready", "status_detail": null, "tags": [ "legal", "faq" ], "source_url": null, "source": "Employee handbook, 2026 edition", "site": null, "created_at": "2026-10-12T09:30:00.000Z", "updated_at": "2026-10-12T09:30:00.000Z" }, "request_id": "req_01K9X7M2Q4" }

{ "error": { "type": "<string>", "code": "<string>", "message": "<string>", "param": "<string>", "docs_url": "<string>", "action_url": "<string>" }, "request_id": "<string>" }

Update a resource

Authorizations

Path parameters

Body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown