Create Guest Profile

POST https://api.podengine.ai/api/v1/guest-profiles

Create a new guest profile with basic information. The profile is created in ACTIVE status along with an associated project. Required fields are firstName, lastName, and shortBio. Optional fields include contact details, social links, and bio details. When provided, LinkedIn URLs trigger a profile scrape, website URLs trigger a website crawl, and company names trigger a SERP search — all run asynchronously in the background. A guest appearances search is also triggered automatically.

API token required Markdown for LLMs

OpenAPI spec

Example request

Install & configure

curl -X POST "https://api.podengine.ai/api/v1/guest-profiles" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_TOKEN" \
  -d '{
  "firstName": "Jane",
  "lastName": "Doe",
  "shortBio": "Jane Doe is a marketing expert with 10 years of experience in B2B SaaS."
}'

const options = {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
  "firstName": "Jane",
  "lastName": "Doe",
  "shortBio": "Jane Doe is a marketing expert with 10 years of experience in B2B SaaS."
})
};

fetch("https://api.podengine.ai/api/v1/guest-profiles", options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

import requests

headers = {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.post("https://api.podengine.ai/api/v1/guest-profiles", headers=headers, json={
  "firstName": "Jane",
  "lastName": "Doe",
  "shortBio": "Jane Doe is a marketing expert with 10 years of experience in B2B SaaS."
})
print(response.json())

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "YOUR_API_TOKEN");
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

var json = @"{
  ""firstName"": ""Jane"",
  ""lastName"": ""Doe"",
  ""shortBio"": ""Jane Doe is a marketing expert with 10 years of experience in B2B SaaS.""
}";
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("https://api.podengine.ai/api/v1/guest-profiles", content);
var data = await response.Content.ReadAsStringAsync();
Console.WriteLine(data);

package main

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

func main() {
	jsonData := []byte(`{
  "firstName": "Jane",
  "lastName": "Doe",
  "shortBio": "Jane Doe is a marketing expert with 10 years of experience in B2B SaaS."
}`)
	body := bytes.NewBuffer(jsonData)
	req, _ := http.NewRequest("POST", "https://api.podengine.ai/api/v1/guest-profiles", body)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "YOUR_API_TOKEN")
	
	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

import { PodEngine } from '@podengine/sdk';

const pe = new PodEngine({ apiKey: process.env.PODENGINE_API_KEY });

const data = await pe.guestProfiles.createGuestProfile({
  firstName: 'Jane',
  lastName: 'Doe',
  shortBio: 'Jane Doe is a marketing expert with 10 years of experience in B2B SaaS.',
});

console.log(data);

import os

from podengine import PodEngine

pe = PodEngine(api_key=os.environ["PODENGINE_API_KEY"])

data = pe.guest_profiles.create_guest_profile(
    first_name="Jane",
    last_name="Doe",
    short_bio="Jane Doe is a marketing expert with 10 years of experience in B2B SaaS.",
)

print(data)

200

Example response

{
  "status": "OK",
  "data": {
    "guestProfileId": "string",
    "guestProfileSlug": "string",
    "projectId": "string",
    "projectSlug": "string"
  }
}