API and Codex

Version 1.0

Easy to understand API let’s you integrate almost anything, giving the power of Affinitomics™ and a versatile AI layer to anything that can connect to the web – for less.

affinitomicswalkthrough

[et_pb_section][et_pb_row] [et_pb_row] Getting Started | How We Work With You [et_pb_row] A Prefrent Software Engineer will sit down with you to establish what data needs  converted to AF relative to your goals We’ll convert the data necessary to get you going and...

read more

RemoveSetFromDomain

Removes a set from the given domain. Arguments domain – the domain id from which the set belongs set_id – the set id to be removed from the domain Response variables (dictionary) domain – the domain used in the request set_id – the set id that was removed in the...

read more

RequestArchetypesByDomain

Returns a list of archetypes associated with the user key and the given domain Arguments domain – the domain id from which to the archetypes belong Response variables (dictionary) archetypes – list of archetype ids that are associated with the given user_key domain –...

read more

RequestRelatedArchetypes

Finds and returns matching archetypes in the given domain to the given archetype id. Arguments domain – the domain id from which to request the related archetypes archetype_id – id of the archetype to use to find related archetypes Response variables (dictionary)...

read more

GetArchetypesInSet

Returns a list of archetypes that are in a given set in the domain. Arguments domain – the domain id from which the set belongs set_id – the set id from which to retrieve archetype ids sets (optional) – list of set ids that the given archetype_id is a member of...

read more

RemoveArchetypeFromSet

Removes an archetype from a given set in the domain. Arguments domain – the domain id to which the set and archetype belongs set_id – the set id to remove the archetype from. archetype_id – the id of the archetype to remove from the given set Response variables...

read more

RelateArchetypeWithSet

Finds and returns matching archetypes to the given archetype id in the given set in the domain. Arguments domain – the domain id from which the archetype belongs set_id – the set id to find related archetypes to the given archetype_id archetype_id – id of the...

read more

RankAgainstArchetypes

Matches a list of given archetypes in the given domain to the given archetype id. Arguments domain – the domain id from which to request the related archetypes archetype_id – id of the archetype to use to find related archetypes rank_archetype_ids – a list of specific...

read more

RequestArchetypes

Returns a list of archetypes associated with the user key Arguments This method does not require any additional arguments Response variables (dictionary) archetypes – list of archetype ids that are associated with the given user_key Example Request { "archetypes": [ {...

read more

RequestArchetypeInfo

Returns all info related to the given archetype id in the domain Arguments domain – the domain id from which to request the archetype info archetype_id – the id of the archetype for the requested info Response variables (dictionary) archetype_id – archetype id for...

read more

RemoveArchetype

Completely removes an archetype from the domain and any association with the user_key Arguments domain – the domain id to which to the archetypes belong archetype_id – id of the archetype to be deleted sets (optional) – list of set ids that the given archetype_id is a...

read more

AddArchetypeToSet

Completely removes an archetype from the domain and any association with the user_key Arguments domain – the domain id from which the set belongs set_id – the set id to add the archetype to. Set will be created, and added to the domain, if it does not already exist...

read more

AddSetToDomain

Adds a set to the given domain. The set id will be unique within the domain. Arguments domain – the domain id to which the set will be added set_id – the set id to be added to the domain. Set will be created, and added to the domain, if it does not already exist...

read more

Status and Errors

All api calls will return the following response variables for your request, in addition to response variables for a specific api method: status – Indicates the result of the api call. Can be 'success' or 'error' errors – a list containing error codes and matching...

read more

SyncArchetype

Syncs an archetype to the Affinitomics server. If the archetype does not yet exist, the server will create an archetype with the given id. If the domain does not yet exist for the given user_key, it will also be created. Note that although the arguments descriptors,...

read more

RequestDomains

Returns a list of domains associated with the user key Arguments This method does not require any additional arguments Response variables (dictionary) domains – list of domain ids associated with the user_key. Domains can be any unique string and are not just limited...

read more

General Arguments

All api calls will need to be provided the following arguments for your request, in addition to arguments necessary for a specific api method: user_key (required) – the api key provided by Prefrent ctype (required) – the type of client making the request cversion...

read more