API Explorer

• Infinit.e API

  • List Methods
  • Expand Methods

  • GET Community - Get api/community/get/:communityId
    Community - Get: Returns the community object for a community matching the ID passed if the user has permissions to view the community (i.e the user is an owner, moderator, or member of the community). Sample IDs to try: 50365c5ce4b0bb23272794b3, 50354114e4b0bb23272794a4, 503663b1e4b0bb23272794b4, 503412f5e4b060be9b30c363

    Parameter	Value	Type	Description
    :communityId		string	ID of the community to return

  • GET Community - Get Public api/community/getpublic/
    Community - Get Public: Returns a list of community objects for all communities that are publicly visible.
  • GET Community - Member Join api/community/member/join/:communityId
    Community - Member Join: Attempts to join a community. If the community accepts open membership, you will be added as a member immediately. If the community requires owner approval, an email will be sent to him and you will not be a member until the owner accepts you. (Sample IDs to try: 50365c5ce4b0bb23272794b3, 50354114e4b0bb23272794a4, 503663b1e4b0bb23272794b4, 503412f5e4b060be9b30c363)

    Parameter	Value	Type	Description
    :communityId		string	Community ID of the community to attempt to join.

  • GET Community - Member Leave api/community/member/leave/:communityId
    Community - Member Leave: Remove yourself as a member from a community. (Sample IDs to try: 50365c5ce4b0bb23272794b3, 50354114e4b0bb23272794a4, 503663b1e4b0bb23272794b4, 503412f5e4b060be9b30c363)

    Parameter	Value	Type	Description
    :communityId		string	Community ID of the community to leave.

  • GET Source - Get api/config/source/get/:id
    Source - Get: Retrieves a source's information based on its ID or Key value.

    Parameter	Value	Type	Description
    :id		string	Source ID or Key value

  • POST Source - Save api/config/source/save/:communityid
    Source - Save: Adds a new source, or updates an existing one via POST.

    Parameter	Value	Type	Description
    :communityid		string	Community ID of the community that the source is associated with
    json		textarea	Source JSON

  • POST Source - Test api/config/source/test/
    Source - Test: Returns documents harvested and enriched according to the POSTed source object. This call can be used to test and debug source configuration prior to saving the object to be harvested (at which point it becomes harder both to debug and to fix problems, eg by deleting documents).

    Parameter	Value	Type	Description
    numReturn		int	Number of processed documents to return (defaults to 10). (Note that this does not affect how many documents are harvested, just how many are enriched. Therefore it may still take a while when run on large directories/databases/fileshares with slow IO.)
    returnFullText	true false	string	If 'false' (default) or 0, does not return the full text of the document (to make the document easier to read etc). If 'true' or '1' returns the populated 'fullText' field (which is sometimes necessary, e.g. to debug the text extraction or cleansing configuration).
    Content-Type	application/json	string	Content type of the content being passed to the API (in this case 'application/json').
    json		textarea	JSON: The JSON based source object to POST to the API.

  • GET Source - User Sources api/config/source/user
    Source - User Sources: Returns a list of sources owned by a user. If the user is a system administrator /config/source/user returns a list of all sources that the user is a member of.
  • GET Knowledge - Document Get api/knowledge/document/get/:documentId
    Knowledge - Document Get: Returns a document matching the id number provided.

    Parameter	Value	Type	Description
    :documentId		string	ID of the document of which to return the metadata
    returnFullText	true false	string	By default, the text of the document is not returned. Setting this parameter to 'true' or '1' will return the first 50KB of the content, in the 'fullText' JSON field (see below).

  • POST Knowledge - Document Query (POST) api/knowledge/document/query/:communityIds
    Knowledge - Document Query: This is the most important API call Infinit.e provides. It takes in a complex query object that controls what input sources are used, what information is desired, how scoring should be performed, and what form the returned information should take.

    Parameter	Value	Type	Description
    :communityIds		string	Community ID, or IDs (comma-separated), or community ID - regex to control which sources the query will use. Obviously the logged-in user must have access rights to those communities. A user's communities can be viewed using the 'person/get' API call
    Content-Type	application/json	string	Content type of the content being passed to the API (in this case 'application/json').
    json		textarea	JSON: Query arguments based as JSON via POST. See: http://developer.ikanow.com/docs/read/Querying_Documents

  • GET Knowledge - Document Query (GET) api/knowledge/document/query/:communityIds
    Knowledge - Document Query: The GET version of this API call is very limited and only works to return ALL documents for one or more communities (as specificed in the communityIds field). For complex queries please use the POST version above or refer to API documentation.

    Parameter	Value	Type	Description
    :communityIds		string	Community ID, or IDs (comma-separated), or community ID - regex to control which sources the query will use. Obviously the logged-in user must have access rights to those communities. A user's communities can be viewed using the 'person/get' API call

  • GET Person - Get api/social/person/get/
    Person - Get: Retrieves the person object for the current user