AgentPixel

Turn on and set up the privacyconsent bar for a pixel.

        controller_name: the business that owns the site (shown in the bar).
        purposes: what the bar asks for. Choose from analytics, resolution,
        newsletter, email_sharing, phone_sharing, partner_email, partner_calls,
        partner_sms. Include "resolution" or no visitor is ever identified.
        site_policy_url: the site's own privacy policy (https). The bar links to
        it, and the hosted notice becomes a short add-on about identification.
        controller_type: company, person, or organization. contact_channels:
        email, phone, sms, agentic. Changing any setting makes a new policy
         version, and returning visitors are asked again.
        Returns ⟨12 unchanged words⟩ 

 ⟨15 unchanged words⟩ type":"null"}],"default":null,"description":"Optional. How the site owner may contact a visitor who consents. Any of: email, phone, sms, agentic. Example: [\"email\"]","title":"Contact Channels"},"controller_contact":{" ⟨3 unchanged words⟩ type":"null"}],"default":null,"description":"Optional. Email address or web address where visitors can reach the site owner about their data. Shown in the hosted notice. Example: [email protected]","title":"Controller Contact"},"controller_jurisdiction":{" ⟨3 unchanged words⟩ type":"null"}],"default":null,"description":"Optional. Where the site owner is based, as plain text, such as a country or US state. Shown in the hosted notice. Example: Florida, USA","title":"Controller Jurisdiction"},"controller_name":{"description":"Name of the business or person that owns the site. It is shown in the consent bar as the party asking the visitor for permission. 1 to 200 characters. Example: Example Shop LLC","maxLength":200,"minLength":1,"title":" ⟨8 unchanged words⟩ type":"null"}],"default":null,"description":"Optional. One of company, person or organization. Describes the site owner in the hosted notice. Example: company","title":"Controller Type"},"data_sharing":{" ⟨3 unchanged words⟩ type":"null"}],"default":null,"description":"Optional. true if the site owner shares consented contact data with other parties, false if not. Shown in the hosted notice. Example: false","title":"Data Sharing"},"disclosed_parties":{" ⟨6 unchanged words⟩ type":"null"}],"default":null,"description":"Optional. Names of the other parties the site owner wants the hosted notice to list, one name per item. Example: [\"Example CRM Inc.\"]","title":"Disclosed Parties"},"pixel_id":{"description":"Exact pixel_id returned by create_pixelof orthe list_pixels;pixel neverto anconfigure. accountExample: IDpx_7a1b2c3d4e5f6a7b","maxLength":80,"minLength":1,"pattern ⟨6 unchanged words⟩ ,"type":"string"},"purposes":{"description":"What the consent bar asks the visitor to allow. One or more of: analytics, resolution, newsletter, email_sharing, phone_sharing, partner_email, partner_calls, partner_sms. Include resolution, or no visitor is ever identified. Example: [\"resolution\", \"analytics\"]","items":{"enum":["analytics","resolution" ⟨20 unchanged words⟩ {"type":"null"}],"default":null,"description":"Optional. HTTPS address of the site's own privacy policy. The bar links to it, and the hosted notice becomes a short add-on about identification. Leave empty to use the hosted notice on its own. Example: https://shop.example.com/privacy","title":"Site Policy Url"}}," ⟨8 unchanged words⟩ 

Confirm the email address fromwith the link6-digit incode, or check whether the signupemail email.link was clicked.

        CopyPreferred: theconfirm_signup(account_id, tokencode, valuesignup_token). fromThe thefirst confirmation URLreturns api_key; store it, it is shown once.
        Link clicked instead: call confirm_signup(?token=...account_id, signup_token) andevery pass5 itseconds, up to 10 minutes, until email_verified is true, then call create_api_key.
        here.A Thiscode activatesallows the5 confirmedattempts trialand account.lasts 24 hours. For a new code, call resend_code(email).
        

{"additionalProperties":false,"properties":{"verification_tokenaccount_id":{"anyOf":[{"description":"account_id returned by signup, not a pixel ID","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","type":"string"},{"type":"null"}],"default":null,"description":"account_id returned by signup_free. Use with code, or with signup_token alone to check whether the email link was clicked. Example: 3f1c2b9e-1d2a-4c5b-9e8f-0a1b2c3d4e5f","title":"Account Id"},"code":{"anyOf":[{"pattern":"^\\d{6}$","type":"string"},{"type":"null"}],"default":null,"description":"The 6-digit code from the AgentPixel email. Ask the person to read it to you. Example: 482913","title":"Code"},"signup_token":{"anyOf":[{"description":"Private token returned by signup or confirmation link; never publish it","maxLength":512,"minLength":1,"type":"string"},{"type":"null"}],"default":null,"description":"signup_token returned by signup_free. With code, the first confirmation also returns the API key. Alone with account_id, returns whether the email is confirmed.","title":"VerificationSignup Token"},"verification_token":{"anyOf":[{"description":"Private token returned by signup or confirmation link; never publish it","maxLength":512,"minLength":1,"type":"string"}},{"requiredtype":["verification_tokennull"}

GetIssue youran API key after the email is confirmed.

        RequiresNot theneeded account_idwhen andconfirm_signup signup_tokenalready fromreturned trialapi_key. registration.
        ReturnsEach acall privateissues APIanother key, once.so Keepcall it once.
        Returns the key confidential.once. Store it securely and attach it to the connection.
        

 ⟨3 unchanged words⟩ "account_id":{"description":"account_id returned by signup, not asignup_free. pixelExample: ID3f1c2b9e-1d2a-4c5b-9e8f-0a1b2c3d4e5f","pattern":"^[0-9a-fA-F]{8}-[ ⟨16 unchanged words⟩ :"string"},"signup_token":{"description":"Private tokensignup_token returned by signup or confirmationsignup_free. link;It neverlasts publish24 ithours.","maxLength":512,"minLength":1,"title ⟨11 unchanged words⟩ 

Create a pixel for a domain and return the HTML snippet to paste on that site.domain.

        Does not create an API key. The account must already be active.
        Next: call configure_consent(pixel_id, controller_name, purposes) and install the snippet it returns.
        Do not install a snippet before consent is configured. install_status starts as not_checked until check_install runs.
        

 ⟨3 unchanged words⟩ :{"domain":{"description":"Public hostname onlyof the site, without scheme, port, path, or IP address. EvaluatorExample: staging.allsourcedata.io onlyshop.example.com","maxLength":253,"minLength":3,"pattern ⟨17 unchanged words⟩ 

Read consented contacts

Resolved contactsContacts for one pixel.

        Pass on as a UTC day (YYYY-MM-DD), or after as the high_water from the
         previous pull. Pass one of them. after 0 starts at the first stored contact.
        Use high_water as the next cursor. 
        New contacts can arrive between reads.
         This does not resolveidentify new visitors. 
        Evaluation returns labeled synthetic
         examples only after current resolution consent is saved; withdrawal hides them.
        

 ⟨49 unchanged words⟩ type":"null"}],"default":null,"description":"Cursor for incremental reads: the high_water value from your previous pull, or 0 to start at the first stored contact. Use exactly one of on or after. Example: 0","title":"After"},"on":{"anyOf" ⟨21 unchanged words⟩ type":"null"}],"default":null,"description":"UTC calendar date in YYYY-MM-DD form. Returns contacts stored on that day. Use exactly one of on or after. Example: 2026-10-12","title":"On"},"pixel_id":{"description":"Exact pixel_id returned by create_pixel orwhose list_pixels;contacts neverto anread. accountExample: IDpx_7a1b2c3d4e5f6a7b","maxLength":80,"minLength":1,"pattern ⟨14 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"Read consented contacts"}

{"additionalProperties":false,"properties":{"pixel_id":{"description":"Exact pixel_id returned by create_pixel or list_pixels;list_pixels, never an accountaccount_id. IDExample: px_7a1b2c3d4e5f6a7b","maxLength":80,"minLength":1,"pattern ⟨14 unchanged words⟩ 

{"additionalProperties":false,"properties":{"pixel_id":{"description":"Exact pixel_id returned by create_pixelwhose orhosted list_pixels;notice neverto anread. accountExample: IDpx_7a1b2c3d4e5f6a7b","maxLength":80,"minLength":1,"pattern ⟨14 unchanged words⟩ 

Start no-card30-day trial

Start a 30-day trial. Notrial, creditno cardcard. required.After Thenthat, $1 per account/month.
        Includesaccount per month for 3 pixels and 500 new contacts per UTC calendar month,month.

        Sends witha no6-digit extracode charges.

        Returnsto account_idthe andemail signup_token.address. AReturns confirmationaccount_id emailand issignup_token; sentkeep toboth.
        Next: ask the
        email address.person Openfor the link6-digit code in thatthe AgentPixel email, copy thethen tokencall fromconfirm_signup(account_id, thecode, URL
        (?token=...signup_token). 
        The account remains pendingsignup_token untillasts email24 confirmation.hours.
        

{"additionalProperties":false,"properties":{"code":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Optional trial code from a directory or listing, such as SMITHERY60. An unknown code never blocks signup. Example: GLAMA60","title":"Code"},"display_name":{"description":"Name shown on the account, such as the person's name or the business name. 1 to 200 characters. Example: Pat Lee","maxLength":200,"minLength":1,"title":"Display Name","type":"string"},"email":{"description":"Email address of the person who will own the account. The 6-digit code is sent here. Ask the person for it; never invent or guess an address. Example: [email protected]","maxLength":254,"minLength":3,"pattern": ⟨18 unchanged words⟩ 

 ⟨5 unchanged words⟩ :true,"readOnlyHint":false,"title":"Start no-card30-day trial"}

Which account this connection's API key belongs to.

        status is the account state after email confirmation andconfirmation. checkout.
        plan is "free" (the trial plan id) during the 30-day trial, 
        paid after the subscription, or unlimited for internal accounts. trial_ends_at is when the trial ends.
        key_prefix is the start of the key, not the key.
        

{"additionalProperties":false,"properties":{"contact_channels":{"anyOf":[{"items":{"enum":["email","phone","sms","agentic"],"type":"string"},"type":"array"} ⟨26 unchanged words⟩ title":"Controller Jurisdiction"},"controller_name":{"maxLength":200,"minLength":1,"title":"Controller Name","type":"string" ⟨33 unchanged words⟩ title":"Disclosed Parties"},"pixel_id":{"description":"Exact pixel_id returned by create_pixel or list_pixels; never an account ID","maxLength":80,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Pixel Id","type":"string"},"purposes":{"items":{"enum":["analytics","resolution","newsletter","email_sharing","phone_sharing","partner_email","partner_calls","partner_sms"],"type":"string"},"maxItems":8,"minItems":1,"title":"Purposes","type":"array" ⟨20 unchanged words⟩ 

 ⟨19 unchanged words⟩ (?token=...) and pass it
        here. This activates a free account. After confirmation, call
        create_api_key(account_id, signup_token) to getthe yourconfirmed APItrial key.account.
        

{"additionalProperties":false,"properties":{"verification_token":{"description":"Private token returned by signup or confirmation link; never publish it","maxLength":512,"minLength":1,"title":"Verification Token","type":"string ⟨6 unchanged words⟩ 

Get your API key after the email is confirmed.

        UseRequires the account_id and signup_token returned by signup_free. Thefrom keytrial isregistration.
        shown once - store it. Attach it as Authorization:Returns Bearera <key>private onAPI future
        connectionskey toonce. useKeep the otherkey tools.confidential.
        

{"additionalProperties":false,"properties":{"account_id":{"description":"account_id returned by signup, not a pixel ID","pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$","title":"Account Id","type":"string"},"signup_token":{"description":"Private token returned by signup or confirmation link; never publish it","maxLength":512,"minLength":1,"title":"Signup Token","type":"string ⟨7 unchanged words⟩ 

{"additionalProperties":false,"properties":{"domain":{"description":"Public hostname only, without scheme, port, path, or IP address. Evaluator: staging.allsourcedata.io only","maxLength":253,"minLength":3,"pattern":"^[A-Za-z0-9](?:[A-Za-z0-9.-]*[A-Za-z0-9])?$","title":"Domain","type":"string"} ⟨6 unchanged words⟩ 

 ⟨25 unchanged words⟩ after 0 starts at the first stored contact.
        The sameUse afterhigh_water returnsas the samenext set.cursor. New contacts can arrive between reads.
        This does not resolve new visitors. Evaluation returns labeled synthetic
        examples only after current resolution consent is saved; withdrawal hides them.
        

{"additionalProperties":false,"oneOf":[{"properties":{"after":{"type":"null"},"on":{"type":"string"}},"required":["on"]},{"properties":{"after":{"type":"integer"},"on":{"type":"null"}},"required":["after"]}],"properties":{"after":{"anyOf":[{"description":"Stored contact ID high_water from previous pull; 0 starts at first contact. Choose after OR on, exactly one","maximum":9223372036854776000,"minimum":0,"type":"integer"},{"type":"null" ⟨3 unchanged words⟩ After"},"on":{"anyOf":[{"description":"UTC calendar date YYYY-MM-DD; choose on OR after, exactly one","pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},{"type":"null"}],"default":null,"title":"On"},"pixel_id":{"description":"Exact pixel_id returned by create_pixel or list_pixels; never an account ID","maxLength":80,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Pixel Id","type":"string ⟨6 unchanged words⟩ 

{"additionalProperties":false,"properties":{"pixel_id":{"description":"Exact pixel_id returned by create_pixel or list_pixels; never an account ID","maxLength":80,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Pixel Id","type":"string ⟨6 unchanged words⟩ 

{"additionalProperties":false,"properties":{"pixel_id":{"description":"Exact pixel_id returned by create_pixel or list_pixels; never an account ID","maxLength":80,"minLength":1,"pattern":"^[A-Za-z0-9_-]+$","title":"Pixel Id","type":"string ⟨6 unchanged words⟩ 

{"additionalProperties":false,"properties":{},"title":"list_pixelsArguments","type":"object"}

{"additionalProperties":false,"properties":{},"title":"setup_statusArguments","type":"object"}

 ⟨46 unchanged words⟩  copy the token from the URL
        (?token=...), then call confirm_signup with it. After. confirmation,The call
        create_api_keyaccount toremains getpending youruntil APIemail key.confirmation.
        

{"additionalProperties":false,"properties":{"display_name":{"maxLength":200,"minLength":1,"title":"Display Name","type":"string"},"email":{"maxLength":254,"minLength":3,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$","title":"Email","type":"string"} ⟨7 unchanged words⟩ 

{"additionalProperties":false,"properties":{},"title":"whoamiArguments","type":"object"}