Production checklist

​

Choose the operation

​

Protect your API key

• Do not include it in browser JavaScript, mobile bundles, public environment variables, or client-side localStorage.
• Do not print the value while debugging. Log only whether the variable exists.
• Rotate a key that appears in source control, build logs, screenshots, or chat history.
• Grant only the API-key scopes the integration needs. Dashboard team roles and key scopes govern different access.
• Use a backend route when a browser needs Context.dev data.

​

Limit each request

​

Set cache freshness

1. How fresh must the source fetch be when Context.dev handles the request?
2. How long can this application reuse the returned value without another API call?

​

Plan for slow requests

• Show an honest loading state when the user must wait.
• Run crawls, batches, and broad product extraction in a background job.
• Prefetch eligible Brand or styleguide data when you learn the identifier before the result is needed.
• Set timeoutOpts.milliseconds according to the product’s latency budget, not an arbitrary HTTP-client default.
• Use timeoutOpts.behavior: "return-partial" when usable incomplete data helps. Preserve partial: true or finalDOMState: "still-loading" in your UI and storage; see Timeouts and partial results.

​

Set a retry policy

​

Handle missing fields

curl https://api.context.dev/v1/brand/retrieve \
  --request POST \
  --header "Authorization: Bearer $CONTEXT_DEV_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "type": "by_domain",
  "domain": "stripe.com"
}'

import ContextDev from "context.dev";

const client = new ContextDev({ apiKey: process.env.CONTEXT_DEV_API_KEY });

const response = await client.brand.retrieve({
  type: "by_domain",
  domain: "stripe.com",
});

console.log(response.brand?.title);

import os
from context.dev import ContextDev

client = ContextDev(api_key=os.environ["CONTEXT_DEV_API_KEY"])

response = client.brand.retrieve(
    type="by_domain",
    domain="stripe.com",
)

print(response.brand.title if response.brand else None)

require "cgi/core"
require "context_dev"

client = ContextDev::Client.new(api_key: ENV.fetch("CONTEXT_DEV_API_KEY"))

response = client.brand.retrieve(
  body: {
    "type" => "by_domain",
    "domain" => "stripe.com",
  }
)

puts response.brand&.title

package main

import (
    "context"
    "fmt"
    "os"

    contextdev "github.com/context-dot-dev/context-go-sdk/v2"
    "github.com/context-dot-dev/context-go-sdk/v2/option"
)

func main() {
    client := contextdev.NewClient(option.WithAPIKey(os.Getenv("CONTEXT_DEV_API_KEY")))
    response, err := client.Brand.Get(context.Background(), contextdev.BrandGetParams{
        OfByDomain: &contextdev.BrandGetParamsBodyByDomain{
            Domain: "stripe.com",
        },
    })
    if err != nil {
        panic(err)
    }
    fmt.Println(response.Brand.Title)
}

<?php

require __DIR__.'/vendor/autoload.php';

$client = new ContextDev\Client(apiKey: getenv('CONTEXT_DEV_API_KEY'));

// Use the SDK's low-level request: its generated Brand helper cannot express this lookup.
$response = $client->request(
    method: 'post',
    path: 'brand/retrieve',
    body: [
      "type" => "by_domain",
      "domain" => "stripe.com",
    ],
);
$data = json_decode((string) $response->getBody(), true, flags: JSON_THROW_ON_ERROR);
echo $data['brand']['title'] ?? 'No match', PHP_EOL;

// Continue after the TypeScript request above.
const domain = "stripe.com";

const brand = response.brand;
const name = brand?.title ?? domain;
const logo = brand?.logos?.find((asset) => asset.type === "logo")?.url;

return {
  name,
  logo: logo ?? null,
  enrichmentStatus: brand ? "matched" : "unmatched",
};

• Keep the user’s original input as a fallback.
• Do not assume array index zero is the correct asset for every UI.
• Distinguish “not returned” from a false or zero business value.
• Do not describe discovered addresses, headcounts, contacts, or classifications as verified legal records.

​

Validate extracted data

• A valid URL can still point to the wrong kind of source.
• A number can satisfy the schema but use the wrong unit.
• A classification code can be valid while its confidence is too low for automatic action.
• A required, non-null field can force a poor fallback when the source never states a value.

​

Track usage and failures

• Operation and a non-sensitive request identifier.
• HTTP status and error_code.
• Attempt count and total latency.
• Cache status and age when returned.
• Crawl totals, not scraped page bodies, unless your data policy permits content logs.
• key_metadata.credits_consumed when cost attribution is required.
• Request tags for product or environment attribution.

​

Before launch

• Secret key exists only on the server.
• The operation, page cap, timeout, and cache age are explicit.
• Expected no-result states have a product fallback.
• Retries are bounded and exclude permanent failures.
• Optional fields and empty arrays are handled.
• Structured output is schema-validated.
• Usage, latency, and error categories are observable.

​

Next steps