Create an API key

Embed

<a href="https://seolyticize.com/docs/ref-create-api-key"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/6f5d2ea6-498c-4c58-8c7a-e79e05343cd4/social-card.svg?v=3e7ae33eec8b" alt="Create an API key" width="600" height="315"></a>

POSThttps://seolyticize.com/api/v1/tools/create_api_key

Mints an API key, agency-wide or pinned to one client, with a role: client_viewer (read-only), analyst, manager, site_admin or admin. Answers 'give this integration its own key'. For an agent that runs one site, pin it to that client with site_admin: full control of that client — connecting consoles, crawls, onboarding — and none of the agency's settings, team, keys or billing; the key cannot even see other clients. A client-pinned key is at most site_admin, and site_admin needs a clientId. expiresInDays makes it stop working on its own. The key is in the response once and can never be shown again. A key cannot be given more access than the caller has.

Request body application/json

namestringrequired

clientIdstring

rolestring

client_viewer | analyst | manager | site_admin | admin = manager

expiresInDaysinteger

{
  "name": "string",
  "clientId": "string",
  "role": "manager",
  "expiresInDays": 0
}

Code samples

cURL

curl -X POST "https://seolyticize.com/api/v1/tools/create_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","clientId":"string","role":"manager","expiresInDays":0}'

TypeScript

const res = await fetch('https://seolyticize.com/api/v1/tools/create_api_key', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name":"string","clientId":"string","role":"manager","expiresInDays":0}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://seolyticize.com/api/v1/tools/create_api_key",
    headers={
    "Content-Type": "application/json",
    },
    json={"name": "string", "clientId": "string", "role": "manager", "expiresInDays": 0},
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://seolyticize.com/api/v1/tools/create_api_key", strings.NewReader(`{"name":"string","clientId":"string","role":"manager","expiresInDays":0}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://seolyticize.com/api/v1/tools/create_api_key');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"name":"string","clientId":"string","role":"manager","expiresInDays":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://seolyticize.com/api/v1/tools/create_api_key')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"name":"string","clientId":"string","role":"manager","expiresInDays":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://seolyticize.com/api/v1/tools/create_api_key"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"name\":\"string\",\"clientId\":\"string\",\"role\":\"manager\",\"expiresInDays\":0}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Responses

200 The tool's result, under data.

Example

{
  "data": {}
}

Schema

datarequired

400 The body was not JSON or did not match the tool's input schema.

Example

{
  "error": "string"
}

Schema

errorstringrequired